Importación de las API
Función
Esta API se utiliza para importar las API. El contenido del archivo importado debe cumplir con el estándar Swagger. Para obtener detalles sobre los campos extendidos personalizados de APIG, véase la sección "Importación y exportación de API" > "Definición extendida" en la Guía de usuario del API Gateway.
Método de invocación
Para obtener más información, véase invocación de API.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/import
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto. |
|
instance_id |
Sí |
String |
ID de gateway, que se puede obtener de la información de gateway en la consola de APIG. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
is_create_group |
No |
Boolean |
Especifica si se va a crear un grupo de API. Predeterminado: true |
|
group_id |
No |
String |
ID de grupo de API. Este parámetro es necesario si is_create_group se establece en false. |
|
extend_mode |
No |
String |
Modo de importación de información extendida.
Predeterminado: merge |
|
simple_mode |
No |
Boolean |
Especifica si se habilitará la importación rápida. Predeterminado: false |
|
mock_mode |
No |
Boolean |
Especifica si se debe habilitar el backend simulado. Predeterminado: false |
|
api_mode |
No |
String |
Modo de importación.
Predeterminado: merge |
|
file_name |
Sí |
File |
Cuerpo de la solicitud en formato JSON o YAML para importar las API. |
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
success |
Array of Success objects |
Importar información de éxito. |
|
failure |
Array of Failure objects |
Importar información de error. |
|
swagger |
Swagger object |
Resultado de importación de archivo Swagger. Actualmente, este parámetro no es compatible. |
|
group_id |
String |
ID de grupo de API. |
|
ignore |
Array of Ignore objects |
Las API que no se importan. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
path |
String |
Ruta de solicitud de API. |
|
method |
String |
Método de solicitud de API. |
|
action |
String |
Tipo de importación. Opciones:
|
|
id |
String |
ID de una API importada correctamente. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
path |
String |
Ruta de solicitud de API. |
|
error_msg |
String |
Aparece un mensaje de error por un error de importación. |
|
method |
String |
Método de solicitud de API. |
|
error_code |
String |
Se muestra el código de error de un error de importación. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
Archivo de Swagger No. |
|
result |
String |
Descripción de resultado de importación. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
method |
String |
Método de solicitud de API. |
|
path |
String |
Ruta de solicitud de API. |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 401
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 403
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 404
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Ejemplo de las solicitudes
Importación de las API
{
"is_create_group" : false,
"group_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2",
"file_name" : "APIGroup_test.json"
}
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"group_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2",
"failure" : [ {
"path" : "/test/demo",
"error_msg" : "The API already exists, An API with the same combination of the method, path, and x-apigateway-match-mode fields already exists. API name: API_demo",
"method" : "GET",
"error_code" : "APIG.3301"
} ],
"success" : [ {
"path" : "/test",
"method" : "GET",
"action" : "create",
"id" : "8ae6bcafab6f49d78242bff26ad8a4f0"
} ],
"swagger" : {
"id" : "e2ea8a7c1cfc49b3830437cb79d7fd59",
"result" : "Success"
}
}
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.3201",
"error_msg" : "The API group name already exists"
}
Código de estado: 401
Sin autorización
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Prohibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Código de estado: 404
No se ha encontrado
{
"error_code" : "APIG.3001",
"error_msg" : "API group not found"
}
Código de estado: 500
Error del servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
Aceptar |
|
400 |
Error en la solicitud |
|
401 |
Sin autorización |
|
403 |
Prohibido |
|
404 |
No se ha encontrado |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.
