Azure APIM git integration json file format

Question

According to the document, I am able update my APIs with pull&push commands.

I wonder if there is any document providing the information about the rule of "how to edit these files?"
I only find the information about folder structure.

The reason why I asking this is that I currently use YAML files to update API specs, and now I want to find a way to keep the track of API specs modifications.

Then I find this document, however, the file format is quite different from the YAML files.
So I want to know if the files I pulled from APIM follow some kind of rules that is widely used by developers? Or it is just a special format for Azure APIM only?

Answer 1

@Han Shih 施學翰 I'm unsure if the schema for it is published but it is a custom format which is kind of a consolidated object of all the relevant properties for an API like authentication settings, revisions, operations, schemas, etc.

Since the YAML files that you use are OpenAPI Files, you could instead export the OpenAPI Spec before/after deployment and use this to keep track of changes.

Also, you might want to explore the CI/CD using ARM Templates doc for the official recommendation for controlled development and deployment.