Get hands-on experience with 20+ free Google Cloud products and $300 in free credit for new customers.

How can I upload swagger specs and API documentation?

Not applicable

I want to avoid working with the Apigee Edge UI. Instead, I want to keep the proxies and their artefacts under sourcecontrol, and use the Management API to upload updates. This works well with proxy definitions (xml) and resource-files. However, the swagger yaml-file is tightly bound to the proxy itself, and I want to keep it under source-control just like the other files (ESPECIALLY since there is no revision-control for the specs in the Edge UI). So, my first question is:

1. How can I upload new versions of the swagger specs?

And secondly:

2. How can I script the generation of the API-documentation from the swagger spec? Today, I have to do this manually in the Drupal-based developer-portal. Actually, it doesn't quite work there either, or - it works, but with some error messages along the way. But I manage to get it out there, at least. But when there is an update to the swagger spec, I need to manually delete the API documentation, and then add/re-generate the documentation on the developer portal again. Not exactly a streamlined process. I want to know if Apigee as a platform has support for creating the documentation through an API call, so that I can automate this process. I know I can produce documentation locally (using bootprint-openapi for example), but this triggers yet another question...

And finally:

Is there an API for working with the developer portal? Can I keep the definition of the portal locally (css-files, images, etc, etc), under source control, and then upload modified files to the portal through some API? Or more specifically - is it possible to publish API documentation to the developer portal, through HTTP posts, FTP, or some other means? I want to automate the process of working with my APIs - including the swagger spec and corresponding documentation - as much as possible.

Any input as to how I can automate and streamline this process is much appreciated.

2 8 4,226
8 REPLIES 8