Help Center/ API Gateway/ Developer Guide (Paris Region)/ Importing and Exporting APIs/ Importing APIs
Updated on 2022-02-21 GMT+08:00
View PDF
Share

Importing APIs

Before importing Swagger 2.0 APIs to API Gateway, you need to supplement extended definitions of the APIs. For more information, see Extended Definition.

Importing APIs to a New API Group

When you import APIs to a new API group name, the system creates an API group.

This function is suitable for importing new APIs to API Gateway.

Before importing APIs, ensure that the following requirements are met:

  • Your API group and API quotas are sufficient.
  • The info.title object of Swagger indicates an API group name.
  • If two of the APIs you are importing have the same definition, the former API can be imported successfully and the latter API cannot be imported.
  • Imported APIs must be manually published before they are available for access.

Importing APIs to an Existing API Group

When you import APIs to a specified API group, the system adds them to the API group while retaining the existing APIs.

This function is suitable for importing new or modified APIs to an existing API group.

Before importing APIs, ensure that the following requirements are met:

  • Your API quota is sufficient.
  • If the definition of an API you are importing is the same as that of an existing API, you can overwrite the existing API or retain it. If you leave the existing API alone, the new API will not be imported.
  • Imported APIs must be manually published before they are available for access.