Submit support requests and browse self-service resources.
Olaf van Gorp
Ready to publish APIs? In this blog, we break down API publishing and share how easy it is to publish and secure APIs with Akana.
Table of ContentsWhat Is API Publishing?4 Best Practices For Publishing APIsHow to Publish APIs With AkanaGet Started With AkanaTable of Contents1 - What Is API Publishing?2 - 4 Best Practices For Publishing APIs3 - How to Publish APIs With Akana4 - Get Started With Akana
Publishing APIs is the process of preparing your APIs for your internal developer community, your partners, and other consumers. By publishing an API, you’re marking it as ready-to-use and be called from other applications.
Publishing APIs is an important step to enabling adoption and ultimately API monetization.
But there are important best practices you need to know to be successful with API publishing.
Here are the best practices you need to apply when publishing APIs.
Good documentation makes your API’s purpose and use clear to the audience. It also includes examples of how to use the API. There are even ways to automatically generate interface documentation from OAS or Swagger — if you have the right tool.
It’s also a good idea to have documentation that explains the API operations from a use case perspective. If you have the right platform, such as Akana, you can even embed in-line test client function within your documentation. So, you get to execute the various use case steps while going through the document.
When you publish your API in a portal, you can play around with it in a sandbox. Interact with the API. Test the API. And improve your understanding of it.
This is important from a functional perspective. But it’s also important from a security and availability perspective. Interacting with the API is easy when you have a platform like Akana. In particular, Akana’s security policy-aware test client helps you interact with the API and improve it.
Versioning is a best practice in API publishing. This ensures that you can implement improvements to your API in a new version — without breaking anything in the old API version.
Whenever you publish a new API version, make sure you communicate it to your consumers (and other relevant stakeholders — anyone that has registered an interest with the API). Let them know when the new version will be there, as well as when the old one will be deprecated.
Once you’ve published the API, where and how will you promote it? How will you make sure developers or consumers are able to find and use your API?
Your API portal will play a key role in raising awareness about your API. You may also want to consider promoting your API on platforms where your audience is active, such as developer forums. You can also use partnerships to promote your API.
Watch the API ChallengeSee how Akana makes it easy to publish APIs fast. Take the API challenge. Try Akana >>
See how Akana makes it easy to publish APIs fast.
Take the API challenge. Try Akana >>
Publishing APIs is easy with Akana. Here’s how to do it.
To create APIs, you need to:
In Akana, you can import an existing API or create a new one. Follow along with instructions to create your API >>
When you create an API, you can designate whether the API is private or public. We recommend setting an API to private until you are ready to publish it to consumers.
Recommendation: Typically, you’ll have Akana deployed across multiple environments. So, you’ll have a non-production environment where you create and test your API. And you’ll have a production environment where APIs are published and available to consumers once they’re ready.
Your API needs good documentation.
API documentation provides all the information a developer, partner, or consumer needs about using the API.
In Akana, publishing API documentation is easy. Watch the video below or keep reading for a full recap of publishing API documentation in Akana.
Here’s how you document an API in Akana:
That’s how easy it is to generate documentation for your API. You can also provide additional documentation by uploading a PDF or by linking a webpage / external source.
Recommendation: Add documentation when you create the API that outlines the ideal use case.
Attaching security policies to your API will protect your API and data integrity. This means that you’ll be able to share, promote, and monetize your API without introducing risk to the business.
In many API platforms, configuring security policies is a manual hassle. But in Akana, all it takes is a couple of points and clicks to attach security policies to your API. Policies can be automatically applied (via metadata-driven automation) or they can be inherited from the organization who created the API.
Watch the video to see how — or keep reading for a full recap.
Available security policies in Akana include:
All you need to do is attach the required security policies to your API. In this example, we use OAuth for access management.
That’s how easy it is to attach security policies to your API in Akana.
Recommendation: Apply security policies to your API early in development.
The next step is to publish the API in your API developer portal.
In Akana, publishing APIs means making APIs available to consumers. You can publish APIs to a default portal for internal consumers. You can also generate different portal views to publish APIs for external consumers, for example in an API catalog or API marketplace.
You can manually publish APIs by going into the back-end of your API and setting the visibility to public. Or you can limit visibility for a particular group.
Or you can use automation to promote your API to the production environment — where the visibility setting will automatically update to public.
Once you’ve made APIs available to the public, consumers will be able to access them in your portal.
Recommendation: Use automation in Akana to save time publishing APIs.
Akana provides the best API management platform for accelerating digital transformation in the enterprise.
That’s because Akana delivers:
See for yourself how Akana makes it easy to publish APIs. Sign up to learn if you qualify for a free 6-month trial today.
Publish APIs With Akana ️▶️ Watch a Demo First
Explore more resources:
Technical Sales, Akana
Olaf has over 20 years’ experience with software development and architecture, helping organizations such as Compuware and Capgemini solve enterprise-level integration and governance issues. Olaf has supported the technical sales for Akana API management since 2014, diving deep into security challenges as well as issues specific to financial services, such as PSD2 and Open Banking.