API documentation helps API subscribers understand the functionality of the API, and API publishers to market their APIs better and sustain competition. Using the API Publisher, you can add different types of documentation from different sources. All documents created in the API Publisher have unique URLs to help improve SEO support.
The documentation types supported in the API Publisher as as follows:
- In-line: Hosts documentation (How-tos, Samples, SDK, forums etc.) in the API Publisher itself and allows it to be edited directly from the UI.
- URL: Links to file references (URLs) of an external configuration management system.
- File: Allows to upload the documentation directly to the server.
Tip: Do you want to set different visibility levels to the API documentation than the API? See API documentation visibility.
- Log in to WSO2 API Publisher.
- Click the Edit icon shown below for the API to which you want to add documentation (e.g.,
Select the Docs tab of the API and click Add New Document.
Provide the following details to create a doc in-line.
Name PhoneVerification Type How To Source In-line Summary Check the validity of a phone number
- Click Add Document once done.
- After adding the document, click Edit Content to open an embedded editor.
- The embedded editor opens allowing you to edit the document's content in-line. Add in the content and click Save and Close.
The API's Doc tab opens. Click Add New Document again.
Documentation using a URL
Then provide the following information to create another doc using a URL.
Name CDYNE Wiki Summary
CDYNE Phone Verification API
Type Other (Summary) Source URL
- Click Add Document.
The API's Doc tab opens again. Click Add New Document again to add yet another document using a file.
Documentation using a file
Enter the following information:
Name API Manager Samples Type Samples & SDK Source You can provide any file format (common formats are PDF, HTML, .doc, text) of any size. For example, use the sample PDF file here.
After adding the details, click the Add Document button.
You have now added three documents to the API: in-line, using a URL and a file.
- Log in to the API Store and click the
- Go to the API's Documentation tab and see the documents listed by type. Click the links to see the documentation content.
As a subscriber, you can read the doc and learn about the API.
You have created documentation using the API Publisher and viewed them as a subscriber in the API Store.