The Requirement
- The client wanted to migrate all their monetized APIs from a home-grown API gateway to an industry standard solution. Such solutions have built-in features that can reduce the time-to-market for APIs.
- They wanted to expedite the time taken to productize their API endpoints, thus requiring workflow automation.
- The client needed documentation templates to drastically reduce the API documentation publishing cycle.
The Challenges
- Publishing the documentation for new APIs was a time-consuming process.
- Lack of brand consistency in API documentation due to the absence of a standardized documentation template.
The Solution
- We designed reusable components (shared flows) in the API gateways. We identified the scope of building shared flows and accomplished it through adherence to industry-standard practices.
- We built microservices to onboard new APIs automatically. The WSDL(Web Services Description Language) file contains the signature of how an API can be consumed. This automates the entire process of finding the APIs that can be exposed to customers in a shorter period of time.
- We built templates for faster and standard API documentation, which is needed to expose API endpoints to the portal’s API producers.
Overall Approach
The following diagram illustrates a reusable Apigee shared flow to quickly expose the client APIs
Tech Stack
Business Benefit
- Reduced the time to market for APIs by 3X.
- Helped the client ensure consistency, shorten the development time, and manage the code more efficiently using reusable components.
- Standardized and catalyzed the API documentation process with consistent brand elements. The change in brand element is reflected across the entire set of API documentation.