2. In the service list, click the name of the target service.
3. In the service details, click the Manage API tab to view the API list of the service.
4. Click Import API above the API list to enter the API importing page.
5. Select the Text format (YAML or JSON), click Upload File, and select API description files, or directly enter the API descriptions in the code editor.
6. Click Save, and API Gateway will create APIs based on the descriptions and then return a list of successfully created APIs.
Notes
OpenAPI 3.0.0 API description files in YAML or JSON format are supported.
You can import up to ten APIs at a time.
The uploaded API description files must be suffixed with ".yml" or ".json", and each file can be up to 100 KB in size. The uploaded description files will overwrite the content in the code editor.
An API created successfully will not be published automatically and needs to be published manually to take effect.
To import an API from an OpenAPI 3.0.0 description file, you need to manually add the servers field to define the backend address to be accessed by the API, for example:
servers:
- url: 'http://localhost:8080'
description: Generated server url
Note:
For more information on the mapping between OpenAPI specifications and API Gateway, see Defining APIs.
Yes
No
Was this page helpful?