This documentation is for WSO2 API Manager 2.0.0 View documentation for the latest release.
Create and Publish an API - API Manager 2.0.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

API creation is the process of linking an existing backend API implementation to the API Publisher so that you can manage and monitor the API's lifecycle, documentation, security, community and subscriptions. Alternatively, you can provide the API implementation in-line in the API Publisher itself.

Click the following topics for a description of the concepts that you need to know when creating an API:

The steps below show how to create a new API.

  1. Log in to the API Publisher.
  2. In the APIS menu, click Add New API.
  3. Select the option to design a new API and click Start Creating.
  4. Give the information in the table below and click Add to add the resource.

    FieldSample value
    NamePhoneVerification
    Context
    /phoneverify

     

    Tip: You can define the API's version as a parameter of its context by adding the {version} into the context. For example, {version}/phoneverify. The API Manager assigns the actual version of the API to the {version} parameter internally. For example, https://localhost:8243/1.0.0/phoneverify. Note that the version appears before the context, allowing you to group your APIs according to versions.

    Version1.0.0
    VisibilityPublic
    ResourcesURL patternCheckPhoneNumber
    Request types

    GET, POST

  5. After the resource is added, expand its GET method and update the Produces to application/xml and Consumes to application/json. Next, add the following parameters. You use these parameters to invoke the API using our integrated API Console in later tutorials. Once done, click Next: Implement > .

    Parameter NameDescriptionParameter TypeData TypeRequired
    PhoneNumberGive the phone number to be validatedQueryStringTrue
    LicenseKeyGive the license key as 0 for testing purposeQueryStringTrue


    Alternatively, click Save to save all the changes made to the API. You can come back later to edit it further by selecting the API and clicking Edit. For details about the states of the API see Manage the API Lifecycle .

  6. Click the Managed API option.

  7. The Implement tab opens. Give the information in the table below.

    FieldSample value
    Endpoint typeHTTP/REST endpoint
    Production endpoint

    This sample service has two operations as CheckPhoneNumber and CheckPhoneNumbers. Let's use CheckPhoneNumber here.
    http://ws.cdyne.com/phoneverify/phoneverify.asmx

    To verify the URL, click the Test button next to it.

    Sandbox endpoint

    This sample service has two operations as CheckPhoneNumber and CheckPhoneNumbers. Let's use CheckPhoneNumber here.
    http://ws.cdyne.com/phoneverify/phoneverify.asmx

    To verify the URL, click the Test button next to it.

  8. Click Next: Manage > and give the information in the table below.

    FieldSample valueDescription
    TransportsHTTP and HTTPSThe transport protocol on which the API is exposed. Both HTTP and HTTPS transports are selected by default. If you want to limit API availability to only one transport (e.g., HTTPS), un-check the other transport.
    Subscription TiersSelect allThe API can be available at different levels of service. They allow you to limit the number of successful hits to an API during a given period of time.

  9. Click Save & Publish. This publishes the API that you just created to the API Store so that subscribers can use it.

You have created an API.

You can save partially complete APIs or save completed APIs without publishing them. Select the API and click on the Lifecycle tab to manage the API Lifecycle. For more details about the states of the API see API lifecycle. For more details about the states of the API see API lifecycle.

  • No labels