API Documentation Overview

The API documentation feature in the ProProfs Knowledge Base offers a comprehensive solution for creating and managing API references. This tool empowers you to develop clear and detailed API documentation, ensuring that your users can easily understand and integrate your APIs.

One of the standout features is the "Test API" option, which allows users to interact with API endpoints directly within the knowledge base, making it easier to experiment with and validate the API's functionality.

You can also create and manage different versions of your API documentation seamlessly. ProProfs Knowledge Base provides a user-friendly interface for uploading API references, whether through URLs or JSON/YAML files. Once you've uploaded your OpenAPI specification, the platform will automatically generate interactive API articles within your knowledge base. These articles allow users to access the "Test API" feature, where they can explore available endpoints, parameters, and responses.

To further assist users, the system generates code samples in various programming languages, making it simpler to understand and implement the API. Responses are displayed in a structured manner, enhancing the overall user experience.

Here's how you can create a new API reference:

1. Navigate to the API Documentation module in the ProProfs Knowledge Base portal.

• Go to New > Page of your Knowledge Base site.
• Select API Documentation

2. Select your preferred method to create a new API reference.

3. Click Save to finish.

Need more help?
Contact us via live chat at the bottom right of this page or email us at support@proprofs.com.

Next article →

How to Generate API Documentation