Definindo esquemas para uma API

Editar online

Os componentes do esquema definem esquemas reutilizáveis que fornecem aos desenvolvedores informações sobre a solicitação que devem fazer ou a resposta que eles devem esperar receber ao chamar uma operação de API.

Sobre essa tarefa

Nota: esta tarefa está relacionada à configuração de uma definição de API do OpenAPI 2.0 Para obter detalhes sobre como configurar uma definição de API OpenAPI 3.0 , consulte Editando uma definição de API OpenAPI 3.0.

Uma API criada em OpenAPI 2.0 inclui uma seção onde são definidas as especificações da carga útil da API. As definições de carga útil descrevem a estrutura dos dados transmitidos nas solicitações e respostas da API, utilizando uma variante especializada do esquema JSON específica para OpenAPI. Cada definição de carga útil corresponde a um esquema, que lista os campos de dados esperados. Esses campos de dados são representados como propriedades no esquema e incluem um conjunto de atributos que descrevem seu tipo, valores permitidos, status de obrigatoriedade e outras características. Embora existam inúmeros atributos disponíveis, a maioria deles raramente é utilizada.

É possível concluir essa tarefa usando o aplicativo da UI do API Designer ou usando a UI do API Manager baseado em navegador.

A qualquer momento, você pode acessar diretamente o arquivo YAML de origem do ` OpenAPI ` clicando no ícone "Fonte Ícone de origem OpenAPI". Para voltar ao formulário de criação, clique no ícone Ícone de formulárioFormulário.

Procedimento

  1. Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 2.0 ..
  2. Se já houver um, ou mais esquemas definidos, expanda Definições.
  3. É possível criar um novo esquema ou editar qualquer esquema existente.