Industry standards for API experience
Over the years, many companies building API products have organically converged on a set of standardized documentation patterns and tools that they provide to their customers to learn about their APIs. Although there isn’t a specific list or guide to building API experience components, there are best practices that have been established by the leaders in the space.
API documentation starts with an API reference, which is often made directly from API specifications. There are additional components such as a sandbox, a command-line interface (CLI), software development kits (SDKs), Postman Collections, and so on to aid in the developer’s journey. In addition to tools that help developers get started with using your APIs, there are also tools that are focused on existing customers who might be looking at the API documentation to diagnose a problem with their integration or make enhancements to their existing integration.
There...