Definindo caminhos para uma API

Um Caminho é uma unidade de uma API REST que você pode chamar. Um caminho compreende um verbo HTTP e um caminho URL. Configurando o Caminho, você define como a API é exposta aos seus desenvolvedores.

Sobre esta 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.

O caminho é anexado à URL do servidor para formar a URL completa. Para obter detalhes sobre a configuração de servidores, consulte Definindo servidores para uma API

A qualquer momento é possível alternar diretamente para a origem YAML subjacente do OpenAPI clicando no ícone Origem Ícone de origem OpenAPI . Para retornar ao formulário de design, clique no ícone Formulário . Ícone de formulário

Procedimento

Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 3.0 ..
Se já houver um, ou mais Caminhos definidos, expanda Caminhos.
Para criar um novo Caminho, clique no ícone de inclusão ao lado de Caminhos na área de janela de navegação Para editar um caminho existente, clique no caminho na área de janela de navegação.
Forneça as informações a seguir:
- Caminho: um caminho relativo para um terminal individual.
  O caminho é anexado ao caminho base para construir o URI completo para acessar as APIs. O caminho deve iniciar, mas não terminar, com o caractere /.. Um parâmetro no final do caminho pode conter um qualificador para corresponder um ou mais níveis de caminho.
  
  Se você especificar apenas o nome do parâmetro, um nível desse caminho será correspondido. Se desejar permitir vários níveis do caminho, será possível prefixar o parâmetro com um dos qualificadores a seguir:
  - * para indicar 0 ou mais ocorrências
  - + para indicar 1 ou mais ocorrências
  Os qualificadores + e * só podem ser usados no final do caminho..
  
  Por exemplo, o caminho:
```
/petstore/{type}/{*category}
```
  corresponde aos caminhos a seguir, em que apenas um valor de tipo é correspondido, mas todas (0 ou mais) as categorias são correspondidas:
```
/petstore/cats
/petstore/cats/supplies
/petstore/cats/supplies/health
/petstore/cats/supplies/health/medicines
/petstore/cats/supplies/health/medicines/a/b/c
```
- Referência (disponível ao editar um caminho já existente): uma referência a um caminho que é definido em outro lugar, seja nesta definição de OpenAPI ou em um arquivo externo. Uma referência possibilita a reutilização de um conjunto de operações já definidas para um caminho nesta API ou em um arquivo que seja uma definição de API completa ou um fragmento de OpenAPI.
  A referência usa notação de ponteiro JSON. Por exemplo, uma referência a um caminho chamado /mypath nessa API teria o formato a seguir:
```
#/paths/~1mypath
```
  Os caracteres ~1 são usados para escapar o caractere /, que está sendo usado literalmente no nome do caminho em vez de como um caractere especial.
  Uma referência a um caminho em um arquivo externo chamado path_fragments.yaml teria o formato a seguir:
```
file://path_fragments.yaml/paths/~1mypath
```
- Resumo: um resumo opcional, destinado a se aplicar a todas as operações neste caminho.
- Descrição: uma descrição opcional, destinada a se aplicar a todas as operações neste caminho. É possível usar a sintaxeCommonMark para representação de rich text.
Se estiver criando um novo Caminho, clique em Criar.
Os detalhes do Caminho são exibidos para edição adicional, conforme descrito na etapa 4.
Clique em Salvar quando concluído.