You can add different types of documents to an API. Proper documentation helps API publishers to better market their APIs and sustain competition. Follow the instructions below to add documentation to a selected API in the API Publisher Web application.
1. Log in to WSO2 API Publisher with a user who has been assigned the "creator" role. For more information on creating users and assigning roles, refer to section User Management.
2. Once logged in, the currently available APIs will be listed in the "All APIs" window. Click on the API to which you want to add documentation to. For example,
3. Select the "Docs" tab of the API and click the "Add New Document" link.
4. In the window that appears, the following information can be added to create a document for the API:
- Name: Name of the document. This is mandatory.
- Summary: A short description of the document which will appear in the API store.
- Type: There are several document types available as follows. If required, a new type can also be introduced.
- How To
- Samples and SDK
- Public forum / Support forum ( external link only)
- API message formats
- Other
- Source: Whether the document is stored inline or provided via a URL.
- In-line: Documentation hosted in the API Manager itself. For inline documentation, you can edit the contents directly from the API publisher interface.
- URL: If you already have comprehensive documentation managed by an external configuration management system, you can simply link to those file references (URLs) through the API Manager rather than importing them to the server.
Click the "Add Document" button once information is added.
5. The added document will be listed on the same window. Click the "Edit Content" link associated with the document added.
6. The embedded editor opens allowing you to edit the document contents.
All documents have unique URLs to help improve the SEO support. Once you are done editing the API, it can be published so that it is available to external parties through the API Store. For instructions on publishing an API, refer to section Managing an API Life Cycle.