Skip to main content
All CollectionsBuildAPI Plans
Updating API Documentation
Updating API Documentation

How to create and update the API Documentation (specification) on your product plans

Updated over 7 months ago

As you make changes to the APIs on your gateway, keeping the documentation up to date is good practice.

Apiable supports multiple documentation versions.

With every new version, you have the following options:

Option 1 - Manual upload

If your APIs don't change often and you have an OpenAPI Specification, manually uploading may be the best option.

Option 2 - Manual synchronization

On some API gateways (AWS), Apiable supports synchronization directly. This means that when a new version of the API is created on the API gateway, your API Product Manager may synchronize those changes on demand. This technique synchronizes on an API-by-API basis.

Option 3 - Automatic synchronization

Continuously deliver new API documentation via our Management API.

Did this answer your question?