Tampere University of Technology

TUTCRIS Research Portal

REST API Example Generation Using Javadoc

Research output: Contribution to journalArticleScientificpeer-review

Details

Original languageEnglish
Pages (from-to)447-466
Number of pages20
JournalComputer Science and Information Systems
Volume14
Issue number2
DOIs
Publication statusPublished - 2017
Publication typeA1 Journal article-refereed

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.

Keywords

  • documentation, programming techniques, REST, examples

Publication forum classification

Field of science, Statistics Finland