This documentation is for WSO2 API Manager 1.7.0 View documentation for the latest release.
Page Comparison - Adding Documentation Using Swagger (v.16 vs v.17) - API Manager 1.7.0 - WSO2 Documentation

All docs This doc

Versions Compared

Key

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

...

  1. Log in to the API Publisher, go to the Doc tab of PhoneVerify API and click Edit Content under Swagger Documentation.

  2. The API definition opens. Note that the API definition contains its JSON representation.

    • By default, all the POST and PUT operations have a Payload parameter, which you can use to send any payload when invoking the API.
    • You can use the Query parameters in GET, DELETE operations to send URL-appended values (e.g.,: v=2&length=200).
  3. Modify existing content, add/remove elements, change paths and parameters etc. of the API definition using either of the following editors: Text Editor or the Graphical Tree Editor.

    Info

    The example below shows how we have changed the path for all the HTTP methods of the API definition from /phoneverify/1.0.0/ to /phoneverify/1.0.0/CheckPhoneNumber using both the text editor and graphical tree editor: Note the following regarding API definitions:

    • By default, all the POST and PUT operations have a Payload parameter, which you can use to send any payload when invoking the API.
    • You can use the Query parameters in GET, DELETE operations to send URL-appended values (e.g.,: v=2&length=200).
    • You can add named parameters.
  4. Info

    After the modifications are done, click save.

...

Invoking the interactive documentation

...