SpyREST: Automated RESTful API Documentation Using an HTTP Proxy Server (N)
Authors:
- S M SohanSSS M Sohan
- Craig AnslowCACraig Anslow
- Frank MaurerFMFrank Maurer
- 1 November 2015
- conference paper
- Published by Institute of Electrical and Electronics Engineers (IEEE)
- p. 271-276
Abstract
RESTful API documentation is expensive to produce and maintain due to the lack of reusable tools and automated solutions. Most RESTful APIs are documented manually and the API developers are responsible for keeping the documentation up to date as the API evolves making the process both costly and error-prone. In this paper we introduce a novel technique using an HTTP proxy server that can be used to automatically generate RESTful API documentation and demonstrate SpyREST, an example implementation of the proposed technique. SpyREST uses a proxy to intercept example API calls and intelligently produces API documentation for RESTful Web APIs by processing the request and response data. Using the proposed HTTP proxy server based technique, RESTful API developers can significantly reduce the cost of producing and maintaining API documentation by replacing a large manual process with an automated process.Keywords
This publication has 18 references indexed in Scilit:
- Web API growing pains: Stories from client developers and their code2014
- Validation and Interactivity of Web API Documentation2013
- Functional descriptions as the bridge between hypermedia APIs and the Semantic Web2012
- OmniVoke: A Framework for Automating the Invocation of Web APIs2011
- Investigating Web APIs on the World Wide Web2010
- SaaS support in software documentation systems2010
- Studying the Documentation of an API for Enterprise Service-Oriented ArchitectureJournal of Organizational and End User Computing, 2010
- On the Origin of Services Using RIDDL for Description, Evolution and Composition of RESTful Services2010
- Jadeite2009
- hRESTS: An HTML Microformat for Describing RESTful Web Services2008