Secure API Manager allows you to add inline documentation, add a URL where the users access the documentation, or upload a file that contains the documentation. It also allows you to categorize the documentation that you are adding. You can add procedural (how to) documentation, samples, and SDK documentation, as well as provide URL links to support and developer forums.
Secure API Manager provides an embedded text editor for you to use when you add inline documentation. The text editor provides similar functionality to what you would find when you compose an email.
To add inline documentation:
Log in to the Publisher using an administrator account.
https://lifecycle-manager-dns-name:9444/publisherFind the API where you want to add the documentation.
Click the name of the appropriate API, then click the Docs tab.
Click Add New Document, then use the following information to add the inline documentation.
Specify the name of this documentation that appears in a table on the Docs tab. You can add one or more documentation items an API.
Provide a summary of this documentation item. This information appears in the table on the Docs tab of the API.
Select the type of documentation that you are adding. Select How To, Samples, Public Forum, Support Forum, or Other. If you select Other, you must add an additional summary of the documentation type in the field provided.
For this example, select Inline as the documentation source.
Click Add Document to add an entry to the documentation table on the Docs tab of the API.
Click Edit Content on the new documentation entry in the table on the Docs tab.
Secure API Manager launches an embedded text editor in a separate window.
Add or create the appropriate documentation in the text editor. This is the inline documentation that the users see on the API.
Click Save and Close.
(Conditional) If you want to create additional inline documentation types, repeat Step 4 through Step 8 for each additional documentation type.
To see the documentation as subscribers see it:
Log in to the Store.
https://lifecycle-manager-dns-name:9444/storeClick the name of the appropriate API, then click the Documentation tab.
The Store lists all of the documentation by type.
Expand the documentation type, then click View Content to see the documentation.
You can add a URL to the API that provides a link to the documentation for the API on a Swagger server or for documentation posted online. You can also specify the URLs for your public and support forums for the developers. If you select Public Forum or Support Forum as the documentation Type, Secure API Manager automatically changes the Source to URL.
To add a URL for the documentation:
Log in to the Publisher using an administrator account.
https://lifecycle-manager-dns-name:9444/publisherClick the name of the appropriate API, then click the Docs tab.
Click Add New Document, then use the following information to add the URL for the documentation.
Specify the name of this documentation that appears in a table on the Docs tab. You can add one or more documentation items to an API.
Provide a summary of this documentation item. This information appears in the table on the Docs tab of the API.
Select the type of documentation that you are adding. Select How To, Samples, Public Forum, Support Forum, or Other. If you select Other, you must add an additional summary of the documentation type in the field provided.
For this example, select URL as the documentation source, then specify the URL in the new field that appears.
Click Add Document to add an entry to the documentation table on the Docs tab of the API.
Click Save and Close.
(Conditional) If you want to add additional URLs for the documentation, repeat Step 3 through Step 5 for each additional URL.
To see the documentation as subscribers see it:
Log in to the Store.
https://lifecycle-manager-dns-name:9444/storeClick the name of the appropriate API, then click the Documentation tab.
The Store lists all of the documentation by type.
Expand the documentation type, then click View Content to see the documentation.
If your documentation for the API already exists in a file, Secure API Manager allows you to upload that file to the API. The document is stored on the API and the developers that use the API can download the file. Secure API Manager supports the following file types of any size:
.doc
.html
.txt
To upload a file that contains the documentation:
Log in to the Publisher using an administrator account.
https://lifecycle-manager-dns-name:9444/publisherClick the name of the appropriate API, then click the Docs tab.
Click Add New Document, then use the following information to upload the file that contains the documentation.
Specify the name of this documentation that appears in a table on the Docs tab. You can one or more documentation items added to an API.
Provide a summary of this documentation item. This information appears in the table on the Docs tab of the API.
Select the type of documentation that you are adding. Select How To, Samples, Public Forum, Support Forum, or Other. If you select Other, you must add an additional summary of the documentation type in the field provided.
For this example, select File as the documentation source, then browse to and select the appropriate file that contains the documentation.
Click Add Document to add an entry to the documentation table on the Docs tab of the API.
Click Save and Close.
(Conditional) If you want to add additional URLs for the documentation, repeat Step 3 through Step 5 for each additional URL.
To see the documentation as subscribers see it:
Log in to the Store.
https://lifecycle-manager-dns-name:9444/storeClick the name of the appropriate API, then click the Documentation tab.
The Store lists all of the documentation by type.
Expand the documentation type, then click View Content to see the documentation.