This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Skip to end of metadata
  • Created by Former user, last modified by Former user on Sept 16, 2012
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

API is an artifact type which is implemented as a Configurable Governance Artifact. API is an artifact which can be published to an Artifact Store which is defined to perform a particular task.

Follow the instructions below to add a new API to the Governance Registry.

  1. Sign in. Enter your user name and password to log on to the Management Console.



  2. Click the "Main" button to access the "Metadata" menu.



  3.  From the left navigation menu, under "Add," in the "Metadata" menu, select "API".



  4. On the "Add API" page, specify the following options:



    1. Provider - The name of the provider of API  
    2. Name -  Name of API as it is want to display
    3. Context - URI context path that is used by consumers (E.g. - /phoneverify)
    4. Version - The version of API (in the form of version.major.minor) (E.g. - 1.0.0)
    5. Description - High-level description of API functionality.
    6. Endpoint URL - Endpoint of the back-end service URL (E.g. - http://ws.cdyne.com/phoneverify/phoneverify.asmx)
    7. Sandbox URL - Endpoint of sandbox (testing) back-end service. A sandbox URL is meant to be used for online testing of an API with easy access to an API key.
    8. WSDL - URL of WSDL file
    9. WADL - URL of WADL file
    10. Thumbnail - Icon to be displayed (can be jpeg, tiff, png format).
    11. Tier Availability - Tiers represents different levels of services, a user has to specify a tier to create an API.
    12. Business Owner and Email - Information about the person responsible for this API at a business level.
    13. Technical Owner and Email - Information about the person responsible for this API at a technical level.
     
  5. An API is made up of one or more resources. Each resource handles a particular type of requests. A resource is analogous to a method (function) in a larger API. A URI template should be defined for an API resources which is a compact sequence of characters for describing a range of Uniform Resource Identifiers through variable expansion (E.g. /phoneverify/{phoneNumber}). 

    The URI template should be defined as in http://tools.ietf.org/html/rfc6570

 





  • No labels