Validation and Interactivity of Web API Documentation

@article{Danielsen2013ValidationAI,
  title={Validation and Interactivity of Web API Documentation},
  author={Peter J. Danielsen and Alan Jeffrey},
  journal={2013 IEEE 20th International Conference on Web Services},
  year={2013},
  pages={523-530}
}
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… CONTINUE READING

Citations

Publications citing this paper.
Showing 1-10 of 11 extracted citations

Automated Example Oriented REST API Documentation at Cisco

2017 IEEE/ACM 39th International Conference on Software Engineering: Software Engineering in Practice Track (ICSE-SEIP) • 2017
View 1 Excerpt

Inferring Web API Descriptions from Usage Data

2015 Third IEEE Workshop on Hot Topics in Web Systems and Technologies (HotWeb) • 2015
View 1 Excerpt

SpyREST in Action: An Automated RESTful API Documentation Tool

2015 30th IEEE/ACM International Conference on Automated Software Engineering (ASE) • 2015
View 2 Excerpts

SpyREST: Automated RESTful API Documentation Using an HTTP Proxy Server (N)

2015 30th IEEE/ACM International Conference on Automated Software Engineering (ASE) • 2015
View 1 Excerpt

Developing a Meta-model to Support End-User Service Composition

2014 IEEE International Conference on Web Services • 2014
View 1 Excerpt

Recommendation in an Evolving Service Ecosystem Based on Network Prediction

IEEE Transactions on Automation Science and Engineering • 2014
View 1 Excerpt

References

Publications referenced by this paper.
Showing 1-10 of 22 references

RDFa core 1.1

B. Adida, M. Birbeck, S. McCarron, I. Herman
W3C Recommendation, 2012, http://www.w3.org/TR/rdfa-core/. • 2012
View 9 Excerpts
Highly Influenced

URI Template

View 5 Excerpts
Highly Influenced

Web application description language

M. Hadley
W3C Member Submission, 2009, http://www.w3.org/Submission/wadl/. • 2009
View 3 Excerpts
Highly Influenced

Port of libxml to JavaScript using Emscripten

A. Zakai
https://github.com/kripken/xml.js.
View 4 Excerpts
Highly Influenced

JSON schema: core definitions and terminology

F. Galiegue, K. Zyp
IETF Internet Draft, 2013, http://tools.ietf.org/html/draft-zypjson-schema. • 2013
View 2 Excerpts

8,000 APIs: Rise of the enterprise

A. Duvander
2012, http://blog.programmableweb.com/2012/11/26/8000-apis-rise-ofthe-enterprise/. • 2012
View 1 Excerpt

Open APIs, what’s hot, what’s not

J. Musser
2012, http://www.slideshare.net/jmusser/j-musser-apishotnotgluecon2012. • 2012
View 1 Excerpt

Web workers

I. Hickson
W3C Candidate Recommendation, 2012, http://www.w3.org/TR/workers/. • 2012
View 1 Excerpt

Design and Describe REST API without Violating REST: A Petri Net Based Approach

2011 IEEE International Conference on Web Services • 2011
View 1 Excerpt

Similar Papers

Loading similar papers…