There are two ways to develop your new API with Akana. In this short video, we go over both methods. One is to design the API from scratch. The other is to create an API by importing an API definition document. This could be an OAS3, Swagger, RAML, or WSDL document.

Two Ways to Use Akana to Develop APIs

Developing APIs From Existing Resources

  1. Click “Add API” From the Main Navigation

When developing an API from existing resources, you can import directly from a URL or a file. In this example we are importing from a file using a Swagger Petstore document.

2. Import the Document

Click “I have an OAS/Swagger/RAML/WSDL/WADL document. Then click, “File” below this. You can then scroll over click save in the lower right-hand corner. The document is then read and the API is created. An implementation of the API is then automatically deployed to the Akana API gateway.

In just a few clicks, you’re all set. Your API is now in the portal and can be found by app developers. Developers can then request access and make calls to the Akana TEST client when granted access.

Developing APIs From Scratch

  1. Click “Add API” From the Main Navigation
  2. Name Your API and Add an Endpoint

The next step is to click “I want to design my API from scratch (REST only).” Give your API a name in the dialogue box. If you know your target endpoint, enter that below your API name. This can also be added later.

  1. Click “Save”

Click save in the lower right-hand corner. Once you click save your API is created. You are then brought to the GUI editor. You can use this editor to define operations. Or click on the “JSON” tab and use the inline parsing Swagger editor to work with the source directly.

  1. Edit Your Resources

In the example above, we use the GUI editor. You can edit default operations by clicking the three dots on the right-hand side of the default operation and then clicking the pencil icon. You can then type a path, and if needed a path parameter, into the pop-up that appears. You may enter as many path parameters as needed. You may also enter a description. You can then select the verb (GET, POST, PUT, DELETE). You can also enter your desired operation ID below the verb field.

Finally, you can enter a summary of the API purpose as well as tags. Click “Finish” in the lower right-hand corner of the pop-up.

That’s how easy it is to create a new API in the Akana Developer Portal.

Related Content

Learn more about developing APIs:

Did you know Akana offers an all-in-one API developer portal and API marketplace? Learn more about the advantages of using the Akana API marketplace. Or, learn about API security best practices as you learn to develop your APIs with Akana. 

Try Akana

See for yourself how easy it easy to develop APIs with Akana. Try it free for 6 months.

Try Akana For Free

Course - Getting Started With Akana