Documentation of API Proxies to their Product

deanwilson
Participant I

We currently have various API proxies under one or more products. As we externalize these API proxies, when a new developer adds their developer app, we ask them to choose a "product". However, we are finding it hard to easily communicate to our external developers which of our "proxies" are located under the various "products".

Is there functionality within apigee to easily produce documentation to show these relationships?

0 1 329
1 REPLY 1

Since the consumers of APIs are developers it probably makes sense to make the Open API spec available to them. For each API product you can provide a download of the spec.

The spec does not provide a notion of "API product" but the tags can be used to our advantage to reflect the API Product. This way you can work with a few specs that do not have any duplication of API resources.

An alternative is to have 1 to 1 mapping between products and specs.

You can start with UX in the portal to arrive at the nature of specs you want to expose.

Providing the spec also enables developers to create SDK and testcases reliably.