Updated on 2023-05-09 GMT+08:00

API Export Precautions

Save the definition of an API on APIG as a Swagger file, and export it in YAML or JSON format. You can export the basic, full, or extended definitions of APIs.

Exporting the Basic Definition of an API

The basic definition of an API is composed of the request and response definitions and does not include the backend definition. The request definition includes both standard and extended Swagger fields.

This function can generate a Swagger API definition file.

Exporting the Full Definition of an API

The full definition of an API is composed of the request, backend, and response definitions.

This function can be used to back up the full definition of an API as a Swagger file.

Exporting the Extended Definition of an API

The extended definition of an API is composed of the request, backend, and response definitions as well as the request throttling policy, access control policy, and other configurations of the API.