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.
How to 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.
3. Select API Documentation in the pop-up window.
4. Click the 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.
Or
To keep all the articles in the draft state, click Save.
You will receive a confirmation message and will be redirected to the article.
How to 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 in the pop-up window.
4. Click the Upload JSON radio to select this method.
5. Click Upload File to browse the file manager of your local device and select the JSON file. After uploading, you will see a file preview in the dialog window.
6. To publish the articles, click Publish.
Or
To keep all the articles in the draft state, click Save.
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.
Next article →