This documentation is for WSO2 API Manager 2.0.0 View documentation for the latest release.
Page Comparison - Add API Documentation In-line, using a URL or a File (v.1 vs v.2) - API Manager 2.0.0 - WSO2 Documentation
Provide Feedback

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

    In-line documentation

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

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

    Image RemovedImage Added

  5. Click the Click Add Document button once done.
  6. After adding the document, click the click Edit Content link associated with it to open an embedded editor.
    Image RemovedImage Added
  7. The embedded editor opens allowing you to edit the document's content in-line. Add in the content and click Save and Close.
    Image Modified
  8. The API's Doc tab opens. Click the Click Add New Document link again 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
    SummaryCDYNE Phone Verification API

    Image Modified

  10. Click the Click Add Document button.
  11. The API's Doc tab opens again. Click the Click Add New Document link again  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.

    Image Modified

  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.
    Image Modified

  14. Log in to the API Store and click the PhoneVerification 1.0.0 API.
    Image RemovedImage Added
  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.
    Image RemovedExpand the categories and click the View Content or Download links to see the documentation content. 
    Image RemovedImage Added

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