API Gateway:Criar uma API REST e adicionar uma operação

Fora de uma instância

1. Faça login no console do Cloud-native API Gateway.

2. No painel de navegação à esquerda, clique em API. Na barra de menu superior, selecione uma região.

3. Clique em Create API.

4. No cartão REST API, clique em Create. No painel Create REST API, configure os parâmetros e clique em Confirme.

   Parâmetro	Descrição
   API Name	Insira um nome para a API. O nome deve ser globalmente único.
   Base path	Caminho base da API. Quando um cliente chama uma operação específica, a URL completa da requisição é http(s)://{domain name}/{base path}/{operation path}.
   Version Management	Defina se o gerenciamento de versões da API será ativado. Versões diferentes de uma API são independentes. Elas compartilham o mesmo nome de API, mas podem ter informações básicas e operações distintas. Para acessar uma versão específica, inclua seu identificador de versão na requisição. Se você ativar o Version Management, também deverá configurar o Usage. Nota Ao definir o Usage como Query, configure o parâmetro Add Query. Ao definir o Usage como Header, configure o parâmetro Add Header.
   Usage	O identificador de versão pode ser transmitido no Path, em um parâmetro de Query ou em um Header. Path: o caminho completo da requisição é /{base path}/{version_number}/{operation_path}. Query: o caminho completo da requisição é /{base path}/{operation_path}. A requisição deve incluir o parâmetro de query especificado em Add Query, com seu valor definido como o número da versão. Header: o caminho completo da requisição é /{base path}/{operation_path}. A requisição deve incluir o header especificado em Add Header, com seu valor definido como o número da versão.
   Description	Insira uma descrição para a API.
   Resource Group	Selecione o grupo de recursos desejado. Para criar um novo, clique em Create Resource Group à direita.

Clique em Create API.

1. No cartão REST API, clique em Create. No painel Create REST API, configure os parâmetros e clique em Confirme.

   Parâmetro	Descrição
   API Name	Insira um nome para a API. O nome deve ser globalmente único.
   Base path	Caminho base da API. Quando um cliente chama uma operação específica, a URL completa da requisição é http(s)://{domain name}/{base path}/{operation path}.
   Version Management	Defina se o gerenciamento de versões da API será ativado. Versões diferentes de uma API são independentes. Elas compartilham o mesmo nome de API, mas podem ter informações básicas e operações distintas. Para acessar uma versão específica, inclua seu identificador de versão na requisição. Se você ativar o Version Management, também deverá configurar o parâmetro Usage. Nota Ao definir o Usage como Query, configure o parâmetro Add Query. Ao definir o Usage como Header, configure o parâmetro Add Header.
   Usage	O identificador de versão pode ser transmitido no Path, em um parâmetro de Query ou em um Header. Path: o caminho completo da requisição é /{base path}/{version_number}/{operation_path}. Query: o caminho completo da requisição é /{base path}/{operation_path}. A requisição deve incluir o parâmetro de query especificado em Add Query, com seu valor definido como o número da versão. Header: o caminho completo da requisição é /{base path}/{operation_path}. A requisição deve incluir o header especificado em Add Header, com seu valor definido como o número da versão.
   Description	Insira uma descrição para a API.
   Resource Group	Selecione o grupo de recursos desejado. Para criar um novo, clique em Create Resource Group à direita.

Dentro de uma instância

1. Faça login no console do Cloud-native API Gateway.

2. No painel de navegação à esquerda, clique em Instances. Na barra de menu superior, selecione uma região.

3. Na página Instances, clique no Instance ID desejado para acessar a página Overview. No painel de navegação à esquerda, clique em API e, em seguida, clique em Create API.

4. No cartão REST API, clique em Create. No painel Create REST API, configure os parâmetros e clique em Confirme.

   Parâmetro	Descrição
   API Name	Insira um nome para a API. O nome deve ser globalmente único.
   Domain Name	Selecione um ou mais nomes de domínio para a API. Para criar um novo nome de domínio, clique em Add Domain Name.
   Base path	Caminho base da API. Quando um cliente chama uma operação específica, a URL completa da requisição é http(s)://{domain name}/{base path}/{operation path}.
   Version Management	Defina se o gerenciamento de versões da API será ativado. Versões diferentes de uma API são independentes. Elas compartilham o mesmo nome de API, mas podem ter informações básicas e operações distintas. Para acessar uma versão específica, inclua seu identificador de versão na requisição. Se você ativar o Version Management, também deverá configurar o Usage. Nota Ao definir o Usage como Query, configure o parâmetro Add Query. Ao definir o Usage como Header, configure o parâmetro Add Header.
   Usage	O identificador de versão pode ser transmitido no Path, em um parâmetro de Query ou em um Header. Path: o caminho completo da requisição é /{base path}/{version_number}/{operation_path}. Query: o caminho completo da requisição é /{base path}/{operation_path}. A requisição deve incluir o parâmetro de query especificado em Add Query, com seu valor definido como o número da versão. Header: o caminho completo da requisição é /{base path}/{operation_path}. A requisição deve incluir o header especificado em Add Header, com seu valor definido como o número da versão.
   Description	Insira uma descrição para a API.
   Resource Group	Selecione o grupo de recursos desejado. Para criar um novo, clique em Create Resource Group à direita.
   Scenario	Selecione o caso de uso para esta operação. Cenário básico: Single Service. Cenários de canary release: By Percentage (Multi-service), By Content (Multi-service) e By Tag (Proportion-based Routing). Nota A soma das porcentagens de tráfego para todos os serviços de destino deve ser 100%.
   Backend Services	Associe um serviço de backend do gateway atual ou da VPC. Se não houver nenhum serviço, clique em Create Service para criar um. Importante Ao criar um novo serviço, as informações de porta podem não aparecer imediatamente. Expanda a lista suspensa Service Name e clique em Refresh. A sincronização das informações é assíncrona e pode levar alguns instantes.

Fora de uma instância

1. Faça login no console do Cloud-native API Gateway.

2. No painel de navegação à esquerda, clique em API. Na barra de menu superior, selecione uma região.

3. Clique em Create API.

4. No cartão REST API, clique em Import. No painel Create File based on OpenAPI, configure os parâmetros e clique em Precheck and Create.

   Parâmetro	Descrição
   API Name	Insira um nome para a API. O nome deve ser globalmente único.
   Upload method	Utilize um Local File ou Import OSS files. Nota Os arquivos para upload local e importação do OSS devem estar em conformidade com a especificação OpenAPI.
   OpenAPI File	Selecione um arquivo local ou cole seu conteúdo de texto. O tamanho do arquivo não pode exceder 30 MB.
   Region selection	Selecione a região onde seus recursos do OSS estão localizados.
   OSS bucket	Selecione um OSS bucket. Buckets sem atributo de região não são suportados.
   Version Management	Defina se o gerenciamento de versões da API será ativado. Versões diferentes de uma API são independentes. Elas compartilham o mesmo nome de API, mas podem ter informações básicas e operações distintas. Para acessar uma versão específica, inclua seu identificador de versão na requisição. Se você ativar o Version Management, também deverá configurar o Usage. Nota Ao definir o Usage como Query, configure o parâmetro Add Query. Ao definir o Usage como Header, configure o parâmetro Add Header.
   Usage	O identificador de versão pode ser transmitido no Path, em um parâmetro de Query ou em um Header. Path: o caminho completo da requisição é /{base path}/{version_number}/{operation_path}. Query: o caminho completo da requisição é /{base path}/{operation_path}. A requisição deve incluir o parâmetro de query especificado em Add Query, com seu valor definido como o número da versão. Header: o caminho completo da requisição é /{base path}/{operation_path}. A requisição deve incluir o header especificado em Add Header, com seu valor definido como o número da versão.
   Description	Insira uma descrição para a API.
   Resource Group	Selecione o grupo de recursos desejado. Para criar um novo, clique em Create Resource Group à direita.

Dentro de uma instância

1. Faça login no console do Cloud-native API Gateway.

2. No painel de navegação à esquerda, clique em Instances. Na barra de menu superior, selecione uma região.

3. Na página Instances, clique no Instance ID desejado para acessar a página Overview. No painel de navegação à esquerda, clique em API e, em seguida, clique em Create API.

4. No cartão REST API, clique em Import. No painel Create File based on OpenAPI, configure os parâmetros e clique em Precheck and Create.

   Parâmetro	Descrição
   API Name	Insira um nome para a API. O nome deve ser globalmente único.
   Domain Name	Selecione um ou mais nomes de domínio para a API. Para criar um novo nome de domínio, clique em Add Domain Name.
   Upload method	Utilize um Local File ou Import OSS files. Nota Os arquivos para upload local e importação do OSS devem estar em conformidade com a especificação OpenAPI.
   OpenAPI File	Selecione um arquivo local ou cole seu conteúdo de texto. O tamanho do arquivo não pode exceder 30 MB.
   Region selection	Selecione a região onde seus recursos do OSS estão localizados.
   OSS bucket	Selecione um OSS bucket. Buckets sem atributo de região não são suportados.
   Version Management	Defina se o gerenciamento de versões da API será ativado. Versões diferentes de uma API são independentes. Elas compartilham o mesmo nome de API, mas podem ter informações básicas e operações distintas. Para acessar uma versão específica, inclua seu identificador de versão na requisição. Se você ativar o Version Management, também deverá configurar o Usage. Nota Ao definir o Usage como Query, configure o parâmetro Add Query. Ao definir o Usage como Header, configure o parâmetro Add Header.
   Usage	O identificador de versão pode ser transmitido no Path, em um parâmetro de Query ou em um Header. Path: o caminho completo da requisição é /{base path}/{version_number}/{operation_path}. Query: o caminho completo da requisição é /{base path}/{operation_path}. A requisição deve incluir o parâmetro de query especificado em Add Query, com seu valor definido como o número da versão. Header: o caminho completo da requisição é /{base path}/{operation_path}. A requisição deve incluir o header especificado em Add Header, com seu valor definido como o número da versão.
   Description	Insira uma descrição para a API.
   Resource Group	Selecione o grupo de recursos desejado. Para criar um novo, clique em Create Resource Group à direita.
   Scenario	Selecione o caso de uso para esta operação. Cenário básico: Single Service. Cenários de canary release: By Percentage (Multi-service), By Content (Multi-service) e By Tag (Proportion-based Routing). Nota A soma das porcentagens de tráfego para todos os serviços de destino deve ser 100%.
   Backend Services	Associe um serviço de backend do gateway atual ou da VPC. Se não houver nenhum serviço, clique em Create Service para criar um. Importante Ao criar um novo serviço, as informações de porta podem não aparecer imediatamente. Expanda a lista suspensa Service Name e clique em Refresh. A sincronização das informações é assíncrona e pode levar alguns instantes.