© Brajesh De 2017

Brajesh De, API Management, 10.1007/978-1-4842-1305-6_4

4. API Documentation

Brajesh De

(1)Bangalore, Karnataka, India

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.

The Importance of API Documentation

As an API ...

Get API Management: An Architect's Guide to Developing and Managing APIs for Your Organization now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.