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 you 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 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 to explore available endpoints, parameters, and responses.
The system generates code samples in various programming languages to further assist users, making it simpler to understand and implement the API. Responses are displayed in a structured manner, enhancing the overall user experience.
How to Generate API Documentation
To generate the API Documentation, you need the API specification file. ProProfs Knowledge Base allows you two methods— upload the specification file as a URL or an OpenAPI Definition file in JSON/YAML format.
Let's explore them in detail.
Generate the API Documentation with a URL
In this method, you have the option to upload the API specification file using a URL.
1. Open your desired project in your ProProfs Knowledge Base account.
2. Go to New > Page at the top.
.png?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kemY4dnF2MjRlcWhnLmNsb3VkZnJvbnQubmV0L3VzZXJmaWxlcy8yMDg2LzMzMzUvY2tmaW5kZXIvaW1hZ2VzL3F1LzIwMjUvU2NyZWVuc2hvdF8yMDI1LTAyLTE3XzE4MzUwNF9fMV8oMSkucG5nIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNzQwNzA3Njg1fX19XX0_&Signature=KZdUs5meoQTQfW9c0OhLYY1CI0IXHI5DlJgthuuKgAOG~w80cdxue4sp6fOZNrY0~CJ60u-TvCz9nzFd0wPU0yJlBkbqNikhWlUv8D40k8wAsVHPYMdf1OswijvB4s~i8UKjDeA1yyeLUMcr~uHEtfEZ7yAo8aFkNObqVg-kWHdu3iS2b6-2eVVA6ePc08PTf5z9bPHH9wBg4wJJnvMIVbYubvzpyENoktp4IvSDGUZqhXgvCwmty4hTJuEf2tBTZDRGQmn2Xc7T-CP5jKZ-Gyntpi0OJJCX7FF~BNsn5kGsE7ytaNGeX5cB5yk1nYJf7hJAEG6aQL0fOWDYDKJTJw__&Key-Pair-Id=K2TK3EG287XSFC)
3. Select API Documentation from the pop-up window.
4. Click Create From URL radio to select this method.
5. Type or paste the URL from which you want to import the API.
6. To publish the articles, click Publish.
7. Make sure to click Save to publish articles.
You will receive a confirmation message and will be redirected to the article.
Generate the API documentation with an OpenAPI definition file
1. Open your desired project in your ProProfs Knowledge Base account.
2. Go to New > Page at the top.
3. Select API Documentation from the pop-up window.
4. Click Upload JSON radio to select this method.
5. Click Upload File to browse your local device's file manager and select the JSON file. After uploading, you will see a file preview in the dialog window.
6. To publish the articles, click Publish.
7. Make sure to click Save to publish articles.
You will receive a confirmation message and will be redirected to the article.
Need more help?
Contact us via live chat at the bottom right of this page or email us at support@proprofs.com.