I'm curious to know about effective methods for documenting the dependencies associated with an API built in Azure API Management. For instance, if an API refers to a product and has multiple operations, each of these operations might connect to different backends, named values, fragments, and send-requests. I'm particularly interested in how to document these aspects for purposes such as migrating APIs between platforms, deploying APIs and their dependencies across different environments, and for future reference. I would appreciate any insights you might have on how you currently manage this and if there are existing tools that could assist in this process.
1 Answer
You can actually manage all of that using .bicep files along with OpenAPI spec files, which can be easily deployed to any environment through a pipeline. This approach is super helpful as it effectively self-documents all your dependencies.
Thanks for your input! If I were to deploy a brand new API to a higher environment for the first time, how could I document that effectively?