Criando um corpo de solicitação

Um corpo da solicitação define a estrutura do corpo de uma solicitação de API.

Antes de Iniciar

Abra a janela de criação do corpo da solicitação; consulte Definição dos componentes do corpo da solicitação.

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 Connect.

É 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ário Formulário.

Procedimento

Crie o corpo da solicitação. É possível criar um corpo de solicitação do zero ou referenciar um corpo de solicitação que é definido em um componente do corpo de solicitação.
- Para criar o corpo da solicitação do zero, forneça as informações a seguir na guia Definição:
  - Nome: um nome para o corpo da solicitação.
    Se estiver criando um componente do corpo da solicitação, esse nome definirá uma chave que permite que esse corpo da solicitação seja referenciado em qualquer lugar na definição de API; a referência deve ter o seguinte formato:
    #/components/requestBodies/Name
  - Descrição: uma descrição do corpo da requisição Você pode usar a sintaxe CommonMark para representação em rich text.
  - Necessário: determina se o corpo da solicitação é necessário na solicitação.
- Para referenciar um corpo de solicitação que é definido em um componente do corpo de solicitação, forneça as informações a seguir na guia Referência:
  - Nome: um nome para o corpo da solicitação.
    Se estiver criando um componente do corpo da solicitação, esse nome definirá uma chave que permite que esse corpo da solicitação seja referenciado em qualquer lugar na definição de API; a referência deve ter o seguinte formato:
    #/components/requestBodies/Name
  - Referência de: selecione uma referência a um componente do corpo de solicitação.
Clique em Criar.
Os detalhes do corpo da solicitação são exibidos para edição posterior; consulte Edição do corpo de uma solicitação.