This documentation is for WSO2 API Manager 2.1.0. View documentation for the latest release.

All docs This doc
||
Skip to end of metadata
Go to start of metadata

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 WSO2 API Publisher are as follows:

  • In-line: Hosts documentation (How-tos, Samples, SDK, forums etc.) in WSO2 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.
  • Using the integrated API Console

Do you want to set different visibility levels to the API documentation than the API? See API documentation visibility.

  1. Sign in to the WSO2 API Publisher.
    https://<hostname>:9443/publisher  
  2. Click the Browse icon shown below for the API (e.g., PhoneVerification 1.0.0) to which you want to add documentation.

    In the above screenshot, the APIs are different as they have different names (i.e., PhoneVerification and PhoneVerificationAPI).

  3. Click Go to Overview.

  4. Add in-line documentation.

    1. Select the Docs tab of the API and click Add New Document.

    2. Enter the following details to create documentation in-line.

      NamePhoneVerification
      TypeHow To
      SourceIn-line
      SummaryCheck the validity of a phone number

    3. Click Add Document.
    4. Click Edit Content to open an embedded editor.

      Update button can be used to update/change the document information.


    5. Edit the document content in-line using the embedded editor and click Save and Close.

      The API's Doc tab opens.
  5. Add documentation using a URL.

    1. Click Add New Document to add another doc type.

    2. Enter the following information to create another doc using a URL.

      NameCDYNE Wiki
      Summary

      CDYNE Phone Notify API

      TypeOther (specify)  and type "Phone Notify" in the text box that appears
      SourceURL
      https://cdyne.com/downloads/SPECS_Phone-Notify.pdf

    3. Click Add Document.
      The API's Doc tab opens. 

  6. Add documentation using a file.

    1. Click Add New Document to add yet another document using a file.

    2. Enter the following information.

      NameAPI Manager Samples
      SummaryAPI Manager Samples
      TypeSamples & SDK
      SourceYou can provide any file format (common formats are .pdf, .html, .doc, .txt) of any size. For example, use the sample PDF file here.

    3. Click Add Document.
      You have now added three documents to the API: in-line, using a URL, and a file.

  7. Log in to the WSO2 API Store and click the PhoneVerification 1.0.0 API.
    https://<hostname>:9443/store
  8. 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 documentation and learn about the API.

You have created documentation using the API Publisher and viewed them as a subscriber in the API Store.

  • No labels