Validation and Interactivity of Web API Documentation
Authors:
- Peter J. DanielsenPDPeter J. Danielsen
- Alan JeffreyAJAlan Jeffrey
- 1 June 2013
- conference paper
- Published by Institute of Electrical and Electronics Engineers (IEEE)
- p. 523-530
Abstract
Many Web APIs (by which we mean ones using HTTP as the application protocol) do not publish a machine-readable API description (in a language such as WADL or WSDL) but only provide human-readable documentation, usually in HTML. This documentation may be machine-generated, or it may be hand-edited in which case there is the possibility of errors being introduced into the API description. In this paper we present a Web Interface Language (WIfL) vocabulary for API documentation, which is intended to be embedded in HTML using RDFa annotations. We present the semantics of WIfL, including a formal presentation of inheritance and validation. We discuss our WIfL tools, which include a dynamically generated console for interacting with an API's reference implementation, and a validator which can check an API for internal consistency.Keywords
This publication has 9 references indexed in Scilit:
- URI Template2012
- Emscripten2011
- Design and Describe REST API without Violating REST: A Petri Net Based Approach2011
- Investigating Web APIs on the World Wide Web2010
- On the Origin of Services Using RIDDL for Description, Evolution and Composition of RESTful Services2010
- hRESTS: An HTML Microformat for Describing RESTful Web Services2008
- SA-REST: Semantically Interoperable and Easier-to-Use Services and MashupsIEEE Internet Computing, 2007
- Applied Combinatorics on Words2005
- Uniform Resource Identifier (URI): Generic Syntax2005