Child pages
  • Add API Documentation In-line V2

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  1. Log in to WSO2 API Publisher.
  2. Click  the API to which you want to add documentation to (e.g., PhoneVerification 1.0.0).

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

    In-line documentation

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

    NameSimpleClientPhoneVerification
    TypeHow To
    SourceIn-line
    SummaryEXAMPLE REQUESTS TO PLACEFINDER WEBSERVICE
    Image Removed
    Check the validity of a phone number

    Image Added

  5. Click the Add Document button.
  6. After adding the document, click the Edit Content link associated with it.
    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 RemovedImage Added   
  8. The API's Doc tab opens. Click the Add New Document link again.

    Documentation using a URL

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

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

    CDYNE Phone Verification API

  10. Click the Add Document button.
  11. The API's Doc tab opens again. Click the Add New Document link 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.
    As a subscriber, you can read the doc and learn about the API.
  16. Expand the categories and click the View Content or Download links to see the documentation content.

...