REST API Example Generation Using Javadoc

Petri Rantanen1

  1. Pori Department, Tampere University of Technology, Pori, Finland
    PL 300, 28101 Pori, Finland
    petri.rantanen@tut.fi

Abstract

Formatting and editing documentation can be a tedious process regardless of how well your documentation templates are made. Especially, keeping the code examples up-to-date can be time-consuming and error-prone. The research presented in this article describes a Javadoc extension that can be used to produce example data in combination with automatically generated API method call examples, and explains how the APIs in our implementation are organized to further ease the automatic documentation process. The primary goal is to make generating method call examples for (RESTful) web services easier. The method has been used in the implementation of a media content analysis service, and the experiences, advantages of using the described approach are discussed in this article. The method allows easier validation and maintenance for the documentation of method usage examples with a downside of an increased workload in the implementation of software components required for the automatic documentation process.

Key words

documentation, programming techniques, REST, examples

Digital Object Identifier (DOI)

https://doi.org/10.2298/CSIS161022009R

Publication information

Volume 14, Issue 2 (June 2017)
Year of Publication: 2017
ISSN: 1820-0214 (Print) 2406-1018 (Online)
Publisher: ComSIS Consortium

Full text

DownloadAvailable in PDF
Portable Document Format

How to cite

Rantanen, P.: REST API Example Generation Using Javadoc. Computer Science and Information Systems, Vol. 14, No. 2, 447–466. (2017)