Criando um exemplo

Você inclui exemplos em uma API para esclarecer a especificação da API.

Antes de Iniciar

Ative a janela de criação de exemplo. Para obter detalhes das áreas em sua definição de API de onde é possível criar um exemplo, 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ário Formulário.

Procedimento

Crie o exemplo. É possível criar um exemplo do zero ou referenciar um exemplo que é definido em um componente de exemplo.
- Para criar o exemplo do zero, forneça as informações a seguir na guia Definição:
  - Nome de exemplo: se você estiver criando um componente de exemplo, esse nome definirá uma chave que permite que esse exemplo seja referenciado em qualquer lugar na definição de API; a referência tem o formato a seguir:
```
#/components/examples/Name
```
  - Resumo: uma descrição do resumo do exemplo.
  - Descrição: uma descrição completa do exemplo. Você pode usar a sintaxe CommonMark para representação em rich text.
  - Valor externo: uma URL que aponta para um exemplo literal. Isso fornece a capacidade de referenciar exemplos que não podem ser facilmente incluídos em documentos JSON ou YAML. Por exemplo, poderia ser um PDF.
- Para referenciar um exemplo que é definido em um componente de exemplo, forneça as informações a seguir na guia Referência:
  - Nome de exemplo: se você estiver criando um componente de exemplo, esse nome definirá uma chave que permite que esse exemplo seja referenciado em qualquer lugar na definição de API; a referência tem o formato a seguir:
```
#/components/examples/Name
```
  - Referência de: selecione uma referência a um componente de exemplo.
Clique em Criar.
Os detalhes do exemplo são exibidos para edição posterior; consulte Edição de um exemplo.