Published UI available via URL?

Google Cloud Apigee
1

In other microservice environments such as Spring Java or .NET, there are libraries (SpringFox and Swashbuckle, respectively, among others) that allow the publication of the “prettified” version of an endpoint’s Swagger/OpenAPI spec, usually using the “/swagger.json” URL.

If an API is associated with a spec, is there any way to expose this functionality in Apigee?

Thanks in advance!

2

Yes, this is possible in Apigee with Developer Portals. The high level process of creating an OpenAPI specification and publishing API proxies via a Developer Portal is as follows:

  1. First, create an OpenAPI specification:

https://docs.apigee.com/api-platform/publish/specs/manage-specs

  1. Create one or more API proxies which implements above Open API specification:

https://docs.apigee.com/api-platform/get-started/get-started

  1. Create an API product for exposing above API proxies for API consumers:

https://docs.apigee.com/api-platform/publish/create-api-products

  1. Register API consumers as App Developers:

https://docs.apigee.com/api-platform/publish/adding-developers-your-api-product

  1. Create a Developer/Company Application for securing API proxies using OAuth or API keys:

https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api

  1. Create a Developer Portal:

https://docs.apigee.com/api-platform/publish/portal/build-integrated-portal

  1. Publish above API product via the Developer Portal:

https://docs.apigee.com/api-platform/publish/portal/publish-apis