All docs This doc
Skip to end of metadata
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 62 Next »

API context is used to is used to uniquely identifyAPI 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:

  1. Sign in to the WSO2 API Publisher.
    https://<hostname>:9443/publisher (ex: https://localhost:9443/publisher). Use admin as username and password.

  2. In the APIS menu, click Add New API.
  3. Select Design New REST API and click Start Creating.
  4. Give the information in the table below and click Add to add the resource.

    Field
    Sample value
    Name
    PhoneVerification
    Context

    /phoneverify


    The API context is used by the Gateway to identify the API. Therefore, the API context must be unique. This context is the API's root context when invoking the API through the Gateway.

    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 based on the versions.

    Version
    1.0.0
    Visibility
    Public
    Tags

    phone, checkNumbers

    Tags can be used to filter out APIs matching some search criteria. We recommend adding tags which explain the functionality and purpose of the API. Subscribers can search APIs based on tags.

    ResourcesURL patternCheckPhoneNumber

    Request types

    GET, POST

    The selection of HTTP method should match with the actual back end resource. For example, if the actual back end contains the GET method to get details of an phone number, then that resource should be matched with an GET resource type and with proper context


    More information on URL patterns can be found at Key Concepts#APIresources

  5. After you add the resource, click it's GET method to expand it. Update the value for Produces as application/xml and the value for Consumes as application/json.

    In the resource definition, we define the MIME types. Consumes refers to the MIME type of request accepted by the backend service and Produces refers to the MIME type of response produced by the backend service which you define as the endpoint of the API.

  6. Next, add the following parameters. You use these parameters to invoke the API using our integrated API Console, which is explained in later tutorials. 

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

    HTTP Post

    By design HTTP POST method specifies that the web server accepts data enclosed within the body of the request, hence when adding a POST method API manager adds the payload parameter to the POST method by default.

    Import or Edit API definition

    To import an existing swagger definition from a file or a URL, click Import. Click Edit Source to manually edit the API swagger definition.

  7. Once done, click Next: Implement >.
    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 on Edit. For details about the states of the API see Manage the API Lifecycle.

    The following parameter types can be defined according to the resource parameters you add.

    Parameter TypeDescription
    queryContains the fields added as part of the invocation URL that holds the data to be used to call the backend service.
    headerContains the case-sensitive names followed by a colon (:) and then by its value which carries additional information with the request which defines the operating parameters of the transaction.
    formDataContains a property list of attribute names and values which includes in the body of the message.
    bodyAn arbitrary amount of data of any type which sends with a POST message

    You can use the following Data type categories, supported by swagger.

    • primitive (input/output)
    • containers (as arrays/sets) (input/output)
    • complex (as models) (input/output)
    • void (output)
    • File (input)
  8. Click the Managed API option.  

  9. The Implement tab opens. Enter the information in the table below.

    FieldSample value
    Endpoint type

    HTTP/REST endpoint

    Load balanced and fail over endpoints

    The load balanced and failover endpoint types are not selected in this example. For details about these endpoint types, see Working with Endpoints and ESB Endpoints.

    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. (This is the actual endpoint where the API implementation can be found)

    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.




    For additional information see Enabling CORS for APIs and Adding Mediation Extensions

    You can deploy your API as a Prototyped API in the Implement tab. A prototyped API is usually a mock implementation made public in order to get feedback about its usability. You can implement it Inline or by specifying an endpoint.

    Users can invoke the API without a subscription after publishing the API to the Store. For more information refer Deploy and Test as a Prototype

  10. Click Next: Manage > and enter the information in the table below.

    FieldSample valueDescription
    TransportsHTTP and HTTPS

    The 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.

    You can only try out HTTPS based APIs via the API Console, because the API Store runs on HTTPS.


    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.

    Make Default Version

    Make this the default version makes the api available in the gateway without version in the production and sandbox urls. This feature allows you to create a new version of API and make it as default version and in the client applications you can invoke the same resources without changing the API gateway URL. This allows to create new versions of API with changes and make it allow for existing clients application without client have to change the URLs.

    Please refer Working with Throttling for more information about maximum backend throughput and advanced throttling policies.

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

    You can save partially complete or completed APIs without publishing it. Select the API and click on the Lifecycle tab to manage the API Lifecycle.

You have created an API.

  • No labels