Skip to content
Robert Brandsø edited this page May 22, 2024 · 12 revisions

APIM APIOps enables you to publish and manage your APIs via Azure API Management (APIM) using a GitOps approach. This involves conducting all publishing and configuration of the APIs via a git repository. Such operations are facilitated through configuration in JSON files, alongside the OpenAPI specification available in either JSON or YAML format.

API developers are not required to possess any knowledge about Terraform, as all configurations are executed through JSON files.

Refer to What can be managed by APIM APIOps? for detailed information about the configuration files.

Flow

The diagram below illustrates the flow of APIM APIOps. If you don't have your own way of running Terraform, you can check out the article about pipelines to get a template for Azure Pipelines.

APIM APIOps flow

Inspiration

The inspiration for this project is the APIOps tool, which is located at github.com/Azure/apiops. This is an open-source project created by people at Microsoft, but the project is not supported by the product team at Microsoft.

I tried to follow a lot of the same folder structure in the artifacts folder and configuration needed in the configuration files, but I have also added some functionality. Additionally, I have used their sketch as a starting point for the sketch above. However, their code is not utilized.

The main difference between these two projects is that APIM APIOps, based on Terraform, is declarative, while the Microsoft APIOps project mostly relies on git commits. Terraform offers a very robust and failsafe way of handling this.