API Products

Design elegant documentation pages for your API products using Apiboost.

Importing Proxies

Proxies refer to specifications or specs for your APIs. REST and SOAP services are included out of the box. Support for other formats like GraphQL are not covered in this guide, but are available as add-ons.

As a turnkey feature, specs are imported manually, though Apiboost has API endpoints to support more complex automated implementations.

Want to automate specs with a repo? Contact us to learn more about CI/CD integration.

Adding Product Documentation

Documentation, commonly referred to as API Products, their display to your users, their administration by your team, and how the site handles them are why you’re using Apiboost. First, they need to be created. Aside from authoring educational material for your users, there are some access controls and configs for products that should be set before they’re published.

The Product Catalog

Each API Product added to the portal will populate the API catalog. For admins, this means seeing all APIs, however, the catalog experience may vary from developer to developer if private API Products exist. What one user sees, may not be the case for another, as each experience would be based on permissions either given directly to the developers, or access grants they received through belonging to certain teams.

Even though a developer can gain API access from a team, usage is still restricted specifically to the that team’s apps only.