Skip to Content
API Management: An Architect's Guide to Developing and Managing APIs for Your Organization
book

API Management: An Architect's Guide to Developing and Managing APIs for Your Organization

by Brajesh De
March 2017
Beginner to intermediate
209 pages
6h 28m
English
Apress
Content preview from API Management: An Architect's Guide to Developing and Managing APIs for Your Organization

© Brajesh De 2017

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

4. API Documentation

Brajesh De1 

(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 ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services
QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Mastering Azure API Management: A Practical Approach to Designing and Implementing an API-Centric Enterprise Architecture

Mastering Azure API Management: A Practical Approach to Designing and Implementing an API-Centric Enterprise Architecture

Sven Malvik
Principles of Web API Design: Delivering Value with APIs and Microservices
Continuous API Management

Continuous API Management

Mehdi Medjaoui, Erik Wilde, Ronnie Mitra, Mike Amundsen
API Development: A Practical Guide for Business Implementation Success

Publisher Resources

ISBN: 9781484213056Purchase bookPublisher Website