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:
If you have not registered to the API Cloud yet, go to https://cloud.wso2.com/ and sign up. Then, log in to the API Cloud and the API Publisher Web application will open automatically.
Let's create an publish an API. See the video tutorial here or a step-by-step walk-through of the video tutorial below.
Here's a step-by-step walk-though of the video tutorial:
- Log in to the API Publisher.
- Select the option to design a new API and click Start Creating.
Give the information in the table below and click the Add button to add the resource.
Field Sample value Name PhoneVerification 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://gateway.api.cloud.wso2.com:8243/t/companyn/1.0.0/phoneverify. Note that the version appears before the context, allowing you to group your APIs according to versions.Version 1.0.0 Visibility Public Resources - URL Pattern: CheckPhoneNumber
Request Types: GET, POST
After the resource is added, expand its
GET
method, add the following parameters. You use them to invoke the API using our integrated API Console in later tutorials. Once done, click Implement.Parameter Name Description Parameter Type Data Type Required PhoneNumber Give the phone number to be validated Query String True LicenseKey Give the license key as 0 for testing purpose Query String True Click the Managed API option.
The
Implement
tab opens. TheImplement
tab opens. Give the information in the table below.Field Sample value Endpoint type HTTP endpoint Production endpoint This sample service has two operations as
CheckPhoneNumber
andCheckPhoneNumbers
. Let's useCheckPhoneNumber
here.
http://ws.cdyne.com/phoneverify/phoneverify.asmxTo verify the URL, click the Test button next to it.
Click Manage to go to the
Manage
tab and give the information in the table below.Field Sample value Description Tier Availability Select all The API can be available at different level of service. They allow you to limit the number of successful hits to an API during a given period of time. - Click Save & Publish. This will publish the API that you just created in the API Store so that subscribers can use it.
You have created an API.