API pages, developer portal, and marketplaces

Once an API reaches the point where it can be made available for use, be it in beta or general availability, it is empirical for the success of the API that comprehensive and rich documentation is also made available. Equally important is to ensure that the developer experience (DX) is also considered, thus ensuring that APIs are easy to find, understand, subscribe to, and use (regardless of whether the API is external or internal).

The one thing that most API practitioners agree upon is that an API is only as good as its documentation. Therefore, an API should not be considered done until documentation is also made available.

However, what does comprehensive and rich documentation mean and how ...

Get Enterprise API Management 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.