Photo by on Unsplash. trail Choreo allows you to create, publish and manage all aspects of an API and its’ lifecycle. In this blog post, let’s have a look at how we can create an API that has an already existing service. Create the API Sign in to the Choreo Console at https://console.choreo.dev/ Navigate to the card and click on . APIs Get Started Click in the card on the Create API page. Next Create an API proxy Select the card and click . Design a new REST API Next You can provide the following details or provide details relevant to your service, API Name: API Version: Endpoint : Covid19API 1.0.0 https://disease.sh Click on and your API will be created. You will be directed to the Overview of the API. Create, There are multiple configurations that you can add to your API. You can add the following details related to your API under each configuration: Design Configurations: description, tags Business Info: business owner and technical owner details Documents: documentation related to the API Runtime Configurations: CORS configurations, Application-level security Resources: add GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS resources API Definition: import/download definition, convert to json/yaml Endpoint Configuration: endpoint configuration Subscriptions: Attach a subscription plan to the API and manage subscriptions. To add a resource to the API, follow the steps below. a. Under select . API Configuration, Resources b. Select from the dropdown. c. Enter as the URI pattern and click the button to add the resource.
d. Click . GET HTTP Verb /v3/covid-19/states + Save Deploy the API 1. Click the tab in the left navigation pane. Deploy 2. On the Deployments page, click on . Create a Revision and Deploy 3. Add “This is a Demo revision” as the description and click . Deploy You have now successfully created a revision from the current API and deployed it. Test the API 1. Click the tab in the left navigation pane. Test 2. Click to get an access token. GET TEST KEY 3. Click on the resource that was added previously and click on and then Execute. GET Try it out, We have now successfully created and tested the API. Let’s Publish the API to the Developer Portal so that API consumers can use the API. Publish the API 1. Click the tab in the left navigation pane. Publish 2. Click on the Lifecycle Management page. Publish 3. Click Go To Developer Portal to consume the API from the developer portal. Invoke the API The published API is shown on the Developer portal as below. 1. Click the tab in the left navigation pane. Credentials 2. Click which creates the credentials for an internal application and subscribes to the API using that internal application. Generate Credentials 3. Click on and copy the access token. Generate Access Token 4. Click the tab in the left navigation pane. Try Out 5. Paste the copied access token in the field. Access Token 6. Click on the resource you added and click on and then . GET Try it out, Execute You will be able to see the COVID-19 data for all the states of the USA as the response from the API. You have now successfully created, tested, and published your API in the developer portal and invoked the API successfully!!

Read My Stories

Too Long; Didn't Read

In your car, at home, or at work — Bosch technology shapes many areas of life.

How to Expose Your API Endpoint Using Choreo

Too Long; Didn't Read

Kavishka Fernando

About Author

TOPICS

THIS ARTICLE WAS FEATURED IN...

How to Expose Your API Endpoint Using Choreo

Too Long; Didn't Read

Kavishka Fernando

About Author

TOPICS

THIS ARTICLE WAS FEATURED IN...

RELATED STORIES