1. What is an API documentation tool?

API documentation tool is a feature in Document360 where you can generate interactive API documentation with a specification file.

2. How do I activate the API documentation feature?

The API documentation feature is in the left menu bar below Content tools. Perform the below step to try it for free.

Click API documentation → Get free trial → Proceed

3. Does it impact my existing project?

  • If you would like to try API documentation, we will add a new project version with a set of features relevant to API documentation
  • After you import your first API reference, the 'API Documentation' homepage link is added to the Header navigation of the Knowledge base site. If required, you can update it in the Header navigation settings (Settings → Knowledge base site → Navigation → Header navigation)

4. What is API reference?

An API reference is a documentation resource that provides comprehensive information about the functions, classes, methods, parameters, return types, and other components of an API. It is a guide or manual for developers who want to integrate or use the API in their applications.

5. How many API references can I create with Document360 API documentation?

You can create up to 3 API references in one version. You can purchase additional versions if you wish to add more API references.

6. What are the supported specification file formats?

You can upload your specification file as a URL, JSON, or YAML file.
We support OpenAPI 2.0 and OpenAPI 3.0 in JSON and YAML files.

7. Can I keep the generated API documentation in the draft state?

After adding or updating the API reference, click Close instead of Publish. Then, all the generated API documentation articles are kept in the draft state. If you click Publish, they will be published.

8. What is "Try it"?

The 'Try it!' option allows developers to test the API endpoints directly from the documentation. It typically provides an interactive interface where developers can enter the required parameters for a particular API endpoint and see the resulting response with code samples.

9. Why "Try It!" option is not available on the site?

"Try It!" will be available only when the server variables are defined in the specification file.

10. What are the supported authorization techniques?

  • HTTP authentication
    • Basic
    • Bearer
  • API key
  • OAuth2
    • Authorization flow
    • Authorization flow with PKCE
    • Client Credentials flow
    • Implicit flow
  • OpenID Connect

11. What happens when I resync the specification file?

  • Articles for new endpoints will be generated in the documentation
  • Articles for existing endpoints will be updated if any changes are made in the specification file
  • The custom data added to the documentation will be preserved

12. Can I have the API documentation and Knowledge base articles under the same slug?

You can only keep the API documentation and Knowledge base articles under different slugs. However, you can keep it under the same subdomain.

13. How often does the URL or file is resynced?

We have provided it as a user-driven operation for the URL of OpenAPI Definition file source types. You must manually perform a resync or update the specification file in the Knowledge base portal.

If you wish to perform resync automatically, use the CI/CD Flow source type.