This documentation is for WSO2 API Manager 2.0.0 View documentation for the latest release.
Add API Documentation In-line, using a URL or a File - API Manager 2.0.0 - WSO2 Documentation
Provide Feedback
||
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 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.
  • Using the integrated API Console

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

  1. Log in to WSO2 API Publisher.
  2. Click the Edit icon shown below for the API to which you want to add documentation (e.g., PhoneVerification 1.0.0).
  3. Select the Docs tab of the API and click Add New Document.

    In-line documentation

  4. Provide the following details to create a doc in-line.

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

  5. Click Add Document once done.
  6. After adding the document, click Edit Content to open an embedded editor.
  7. The embedded editor opens allowing you to edit the document's content in-line. Add in the content and click Save and Close.
  8. The API's Doc tab opens. Click Add New Document again.

    Documentation using a URL

  9. Then provide the following information to create another doc using a URL.

    NameCDYNE Wiki
    Summary

    CDYNE Phone Verification API

    TypeOther (Summary)
    SourceURL
    http://api-portal.anypoint.mulesoft.com/cdyne/api/cdyne-phone-verification-api

  10. Click Add Document.
  11. The API's Doc tab opens again. Click Add New Document again to add yet another document using a file.

    Documentation using a file

  12. Enter the following information:

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

  13. 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.

  14. Log in to the API Store and click the PhoneVerification 1.0.0 API.
  15. 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.

  • No labels