Product Documentation

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

Setting Products as Default (optional)

It’s not a common requirement, though some organizations mandate every app use certain API(s). Aside from enforcing a mandate, it’s also convenient for users creating new apps to have everything required added from the get-go.