Welcome to our API documentation page!

3min

Without proper API documentation, developers may struggle to understand how to use the API, leading to errors, bugs, and delays.

With Archbee, managing API documentation is simple. Engineers, PMs, and technical writers can easily publish content or make changes without requiring any code. Developers can try out the API right from the documentation and see what's working (or not). The API references are automatically generated based on the OpenAPI files or Postman Collections, ensuring they are always up-to-date.





How to import an API files

1

Click on Space actions - the 3 dots -> Import.

Document image

2

Then click on Import

Document image

3

Select the .json or .yaml file to upload it



Document image

4

Once imported, go to the API refernces and click on expand

Document image

5

From there, select any API call, such as "Trigger a forgotten password email"



Document image




Updated 25 Jul 2024
Doc contributor
Doc contributor
Did this page help you?