Definindo os componentes do corpo da solicitação

Um componente do corpo de solicitação é uma definição reutilizável da estrutura do corpo de uma solicitação de API.

Sobre essa tarefa

Nota:
  • Esta tarefa está relacionada com a configuração de uma definição de API OpenAPI 3.0. Para obter detalhes sobre como configurar uma definição de API OpenAPI 2.0 , consulte Editando uma definição de API OpenAPI 2.0.
  • OpenAPI 3.0 APIs são suportadas apenas com o DataPower® API Gateway, não com o DataPower Gateway (v5 compatible).
  • Para obter detalhes das limitações de suporte atuais do OpenAPI 3.0 , consulte OpenAPI 3.0 suporte no IBM® API ConnectAI Gateway.

É 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 3.0 ..
  2. Expandir Componentes , se já houver um ou mais componentes de corpo da solicitação definidos, expanda Corpos da solicitação.
  3. É possível criar um novo componente do corpo de solicitação ou editar qualquer componente do corpo de solicitação existente.
    • Para criar um componente do corpo da solicitação, clique no ícone de adição Ícone de inclusão da API OpenAPI 3.0 ao lado de “Corpos da solicitação ” e, em seguida, consulte a seção “Criação de um corpo da solicitação ”.
    • Para editar um componente do corpo da solicitação existente, clique no nome do componente no painel de navegação e consulte a seção “Editando o corpo da solicitação ”.