Gerenciar especificações da API

Esta página se aplica à Apigee e à Apigee híbrida.

Neste documento, descrevemos como gerenciar as especificações da API no Hub de API. Consulte também Introdução às especificações da API.

Adicionar especificações

É possível adicionar uma ou mais especificações a uma versão da API. Saiba mais em Adicionar uma especificação de API a uma versão.

Especificações da lista

Esta seção explica como listar as especificações associadas a uma versão da API.

IU da Apigee

Para listar especificações com a interface:

No console do Google Cloud, acesse a página Hub de APIs.
Acesse o hub de API
Clique em APIs.
Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
Clique em uma API para conferir os detalhes.
Selecione a versão.
Selecione uma especificação para ver os detalhes.

REST

Para listar as especificações da lista associadas a uma versão da API, use a API Especificações da lista:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID/specs"
      -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Substitua:

HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
API_NAME: o nome do recurso da API.
VERSION_ID: o ID da versão.

Exemplo de resposta:

{

}

Mais detalhes da especificação

Esta seção explica como obter detalhes sobre uma especificação de API associada a uma versão.

IU da Apigee

Para ver detalhes de uma especificação usando a interface:

No console do Google Cloud, acesse a página Hub de APIs.
Acesse o hub de API
Clique em APIs.
Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
Clique em uma API para conferir os detalhes.
Selecione a versão que você quer inspecionar.
Selecione uma especificação para ver os detalhes.

REST

Para conferir os detalhes de uma especificação, use a API Receber detalhes da especificação:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID/specs/SPEC_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Substitua:

HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
API_NAME: o nome do recurso da API.
VERSION_ID: o ID da versão.
SPEC_ID: o ID da especificação.

Exemplo de resposta:

{
  "name": "projects/myproject/locations/us-central1/apis/docs-api-3/versions/docs-api-1-version-3/specs/docs-spec-1",
  "displayName": "Test Spec 1",
  "details": {
    "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification.\nYou can find out more about Swagger at [https://swagger.io](https://swagger.io).",
    "openApiSpecDetails": {
      "format": "OPEN_API_SPEC_3_0",
      "version": "1.0.11"
    }
  },
  "createTime": "2024-04-04T22:39:05.098508600Z",
  "updateTime": "2024-04-04T22:39:06.661264958Z"
}

Excluir uma especificação de API

Nesta seção, explicamos como excluir a especificação da API de uma versão. A exclusão de uma especificação também apaga as operações associadas da versão.

IU da Apigee

Para excluir uma especificação de API, use a API Excluir especificação:

Para excluir recursos da API com a interface:

No console do Google Cloud, acesse a página Hub de APIs.
Acesse o hub de API
Clique em APIs.
Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
Clique em uma API para conferir os detalhes.
Selecionar uma versão
Selecione uma especificação para excluir.
Clique em Excluir.

REST

Para excluir um recurso de API do hub de API, use a API Excluir recurso de API:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID/specs/SPEC_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

Substitua:

HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
API_NAME: o nome do recurso da API.
VERSION_ID: o ID da versão.
SPEC_ID: o ID da especificação a ser excluída.

Exemplo de resposta:

{

}

Editar uma especificação

Você pode editar alguns dos atributos de uma especificação. Para conferir uma lista de atributos que podem ser atualizados, consulte API de patch de especificação de versões.

Console

No console do Google Cloud, acesse a página Hub de APIs.
Acesse o hub de API
Clique em APIs.
Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
Clique em uma API para conferir os detalhes.
Selecionar uma versão
Selecione uma especificação.
Clique em Editar.

REST

Para editar uma especificação com a API REST, siga estas etapas:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID/specs/SPEC_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
    '{
      "display-name": DISPLAY_NAME.  # Use the request body to specify attribute changes
      "contents": {
         "contents": Base64-encoded string
         "mimeType": MIME_TYPE
      }
    }'

Substitua:

HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
API_NAME: o nome do recurso da API.
VERSION_ID: o ID da versão.
SPEC_ID: o ID da especificação.
Corpo da solicitação: use o corpo da solicitação para especificar os atributos que serão alterados. Consulte Definição do recurso de especificação.

Acessar o conteúdo da especificação

Esse recurso permite recuperar o conteúdo bruto codificado em Base64 de uma especificação de API que foi enviada ao hub da API.

IU da Apigee

Para ver detalhes de uma especificação usando a interface:

A definir: é preciso checar como isso é feito na interface.

REST

Para conferir os detalhes de uma especificação, use a API Receber detalhes da especificação:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID/specs/SPEC_ID:contents"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Substitua:

HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
API_NAME: o nome do recurso da API.
VERSION_ID: o ID da versão.
SPEC_ID: o ID da especificação.

Exemplo de resposta:

{
  "contents": "Base64-encoded file contents"

}