Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Nesta página

Mostrar todos

Central de ajuda/ API Gateway/ Guia de usuário/ Gerenciamento de API/ Importação e exportação de APIs/ Restrições e compatibilidade

Restrições e compatibilidade

Atualizado em 2024-10-14 GMT+08:00

Ver PDF

Observe as seguintes restrições e problemas de compatibilidade ao importar ou exportar APIs no APIG:

Restrições

Restrições de parâmetros do APIG:
- O APIG não oferece suporte à configuração de parâmetros de solicitação nos locais formData e body.
- O APIG não suporta a configuração de parâmetros consumes e produces.
- Os nomes dos parâmetros de cabeçalho não diferenciam maiúsculas de minúsculas.
As restrições da política de back-end são as seguintes:
- Tipo de back-end padrão HTTP: os back-ends HTTP e HTTP-VPC são suportados.
- Tipo de back-end padrão HTTP-VPC: os back-ends HTTP e HTTP-VPC são suportados.
- Tipo de back-end padrão function: somente o back-end da função é suportado.
- Tipo de back-end padrão mock: somente o back-end mock é suportado.

Compatibilidade

OpenAPI é suportado.
A Especificação de OpenAPI (OAS) define uma interface padrão independente de linguagem para APIs RESTful. A OAS é conhecida anteriormente como Swagger. O APIG suporta duas especificações de OpenAPI: Swagger 2.0 e OpenAPI 3.0. Para facilitar a compreensão, nas seções a seguir, OAS se refere à Especificação de OpenAPI (incluindo Swagger 2.0 e OpenAPI 3.0), Swagger se refere ao Swagger 2.0 e OpenAPI se refere ao OpenAPI 3.0.
Mapeamentos entre objetos de OAS importados ou exportados e objetos do APIG
Diferenças nos tipos de parâmetros de solicitação
Diferenças na sintaxe do modelo de caminho de solicitação da API
Campos estendidos com suporte para APIG ao importar APIs

**Tabela 1** Mapeamentos entre objetos de OAS e objetos do APIG
Objeto de Swagger	Objeto de OpenAPI (3.0.0)	Objeto de APIG	Importação	Exportação
info.title	info.title	Nome do grupo da API	Importação para um novo grupo de API: um novo nome de grupo de API Importação para um grupo de API existente: não usada Um nome de grupo da API consiste de 3 a 64 caracteres, começando com uma letra. Apenas letras, dígitos e sublinhados (_) são permitidos.	Nome do grupo da API
info.description	info.description	Descrição do grupo de API	Importação para um novo grupo de API: descrição sobre o novo grupo Importação para um grupo de API existente: não usada	Descrição do grupo de API
info.version	info.version	Versão	Não usada	Versão definida pelo usuário A hora atual é usada como o nome do grupo de API se nenhum nome for especificado.
host	server.url	Nome de domínio do grupo de API	Não usada	O primeiro nome de domínio definido pelo usuário de um grupo de API é usado preferencialmente. O nome de domínio independente do grupo de API é usado se o grupo de API não estiver vinculado a nenhum nome de domínio definido pelo usuário.
basePath	-	-	Mesclada com o caminho da solicitação de cada API	Não usada
paths.path	paths.path	Caminho de solicitação da API	Mesclada com basePath para usar como um caminho de solicitação de API	Caminho de solicitação da API
operation.operationId	operation.operationId	Nome da API	Nome da API	Nome da API
operation.description	operation.description	Descrição da API	Descrição da API	Descrição da API
operation.parameters	operation.parameters	Parâmetros de solicitação de front-end da API	Parâmetros de solicitação de API	Parâmetros de solicitação de API
operation.schemes	-	Protocolo de solicitação de front-end da API	Protocolo de solicitação de API	Protocolo de solicitação de API
operation.responses	operation.responses	-	Não usada	Resposta padrão
operation.security	operation.security	Modo de autenticação da API	Modo de autenticação da API Usada em conjunto com x-apigateway-auth-type	Modo de autenticação da API Usada em conjunto com x-apigateway-auth-type

**Tabela 2** Diferenças nos tipos de parâmetros de solicitação
OAS	APIG	Atributo suportado
integer long float double	number	maximum minimum default enum required description
string	string	maxLength minLength default enum required description
Outros	Nenhum	Nenhum

**Tabela 3** Diferenças na sintaxe do modelo de caminho de solicitação da API
Sintaxe	OASSwagger	APIG
/users/{userName}	Compatível	Compatível
/users/prefix-{userName} /users/{userName}-suffix /users/prefix-{userName} -suffix	Compatível	Não há suporte para definição de solicitação de front-end Suportado para definição de solicitação de back-end
/users/{proxy+}	Não compatível	Suporte para definição de solicitação de front-end Não há suporte para definição de solicitação de back-end

Tópico principal: Importação e exportação de APIs

Tópico anterior: Importação e exportação de APIs

Próximo tópico: Importação de APIs

Feedback

Esta página foi útil?

Sim Não

Deixar um comentário

Obrigado por seus comentários. Estamos trabalhando para melhorar a documentação.

O sistema está ocupado. Tente novamente mais tarde.

Quais dos seguintes problemas você encontrou?

O conteúdo é inconsistente com a UI do produto

Descrições pouco claras

Falta de exemplos ou código

Passos incorretos

Não encontro o que preciso

Falta de melhores práticas

Feedback (opcional)

0/500

Selecione pelo menos um tipo de problema e insira seus comentários ou sugestões.

Insira um máximo de 500 caracteres.

Enviar Cancelar