API Documentation

  • Brajesh De
Chapter

Abstract

Documenting a REST API is important for its successful adoption. APIs expose data and services that consumers want to use. An API should be designed with an interface that the consumer can understand. API documentation is key to the app developers comprehending the API. The documentation should help the developer to learn about the API functionality and enable them to start using it easily. This chapter looks at the aspects of documenting an API and some of the tools and technologies available for API documentation, including RAML, Swagger, API Blueprint, and others.

Keywords

Resource Type Security Scheme Generate Test Case Error Code Query Parameter 
These keywords were added by machine and not by the authors. This process is experimental and the keywords may be updated as the learning algorithm improves.

Copyright information

© Brajesh De 2017

Authors and Affiliations

  • Brajesh De
    • 1
  1. 1.BangaloreIndia

Personalised recommendations