Criando uma definição de conteúdo

Editar online

Uma definição de conteúdo descreve o conteúdo de uma solicitação, resposta ou parâmetro de API. É possível criar definições de conteúdo em vários lugares em sua definição de API.

Antes de Iniciar

Ative a janela de criação de definição de conteúdo. Para obter detalhes das áreas em sua definição de API de onde é possível criar uma definição de conteúdo, veja os tópicos a seguir:

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árioFormulário.

Procedimento

  1. Forneça as informações a seguir:
    • Tipo de Conteúdo: Selecione o tipo de conteúdo; por exemplo application / json.
      Observação: Embora o campo “Tipo de conteúdo” no editor ofereça uma lista de seleção de tipos de mídia, ao editar diretamente o código-fonte OpenAPI da API, é possível especificar um intervalo de tipos de mídia; por exemplo, text/*, */json, ou */*. Para solicitações ou respostas que correspondem a vários tipos, somente o tipo mais específico é aplicável. por exemplo, text/plain substitui text/*.
  2. Clique em Criar.
    Os detalhes da definição de conteúdo são exibidos para edição adicional; consulte Edição de uma definição de conteúdo.