Définition des chemins d'une API

Un chemin est une unité d'une API REST que vous pouvez appeler. Un chemin se compose d'une instruction HTTP et d'un chemin d'URL. En configurant le chemin, vous définissez la façon dont l'API est exposée à vos développeurs.

A propos de cette tâche

Remarque :

Cette tâche concerne la configuration d'une définition d'API OpenAPI 3.0. Pour plus de détails sur la configuration d'une définition d'API OpenAPI 2.0 , voir Edition d'une définition d'API OpenAPI 2.0.
Les API OpenAPI 3.0 sont prises en charge uniquement avec le DataPower® API Gatewayet non avec le DataPower Gateway (v5 compatible).
Pour plus de détails sur les limitations actuelles de la prise en charge d' OpenAPI 3.0 , voir Prise en charge d'OpenAPI 3.0 dans IBM® API Connect.

Vous pouvez effectuer cette tâche soit à l'aide de l'application d'interface utilisateur API Designer , soit à l'aide de l'interface utilisateur API Manager basée sur un navigateur.

Le chemin est ajouté à l'URL du serveur pour former l'URL complète. Pour plus de détails sur la configuration des serveurs, voir Définition de serveurs pour une API.

A tout moment, vous pouvez passer directement à la source YAML OpenAPI sous-jacente en cliquant sur l'icône Source OpenAPI Icône Source . Pour revenir au formulaire de conception, cliquez sur l'icône Formulaire Icône de formulaire .

Procédure

Ouvrez l'API à des fins d'édition, comme décrit dans Edition d'une définition d'API OpenAPI 3.0.
Si un ou plusieurs chemins sont déjà définis, développez Chemins.
Pour créer un nouveau chemin, cliquez sur l'icône d'ajout en regard de Chemins dans le panneau de navigation. Pour éditer un chemin existant, cliquez sur le nom du chemin dans le panneau de navigation.
Fournissez les informations suivantes :
- Chemin : Chemin d'accès relatif à un noeud final individuel.
  Le chemin est ajouté au chemin de base afin de construire l'URI complet permettant d'accéder aux API. Le chemin doit commencer, mais pas se terminer, par le caractère /. Un paramètre à la fin du chemin peut contenir un qualificateur pour correspondre à un ou plusieurs niveaux de chemin.
  
  Si vous spécifiez uniquement le nom du paramètre, un niveau de ce chemin est mis en correspondance. Si vous souhaitez autoriser plusieurs niveaux du chemin d'accès, vous pouvez préfixer le paramètre avec l'un des qualificateurs suivants:
  - * pour indiquer 0 occurrence ou plus
  - + pour indiquer 1 ou plusieurs occurrences
  Les qualificateurs + et * ne peuvent être utilisés qu'à la fin du chemin.
  
  Par exemple, le chemin:
```
/petstore/{type}/{*category}
```
  correspond aux chemins suivants, où une seule valeur de type est mise en correspondance, mais toutes les catégories (0 ou plus) sont mises en correspondance:
```
/petstore/cats
/petstore/cats/supplies
/petstore/cats/supplies/health
/petstore/cats/supplies/health/medicines
/petstore/cats/supplies/health/medicines/a/b/c
```
- Réf. (disponible lors de l'édition d'un chemin existant) : référence à un chemin défini ailleurs, soit dans cette définition OpenAPI, soit dans un fichier externe. Une référence permet de réutiliser un ensemble d'opérations déjà définies pour un chemin dans cette API ou dans un fichier qui est soit une définition d'API complète, soit un fragment OpenAPI.
  La référence utilise la notation de pointeur JSON. Par exemple, une référence à un chemin appelé /mypath dans cette API aurait le format suivant :
```
#/paths/~1mypath
```
  Les caractères ~1 sont utilisés pour mettre en échappement le caractère / , qui est utilisé littéralement dans le nom de chemin et non comme caractère spécial.
  Une référence à un chemin d'accès dans un fichier externe appelé path_fragments.yaml aurait le format suivant:
```
file://path_fragments.yaml/paths/~1mypath
```
- Récapitulatif : Récapitulatif facultatif, destiné à s'appliquer à toutes les opérations de ce chemin.
- Description : Description facultative, destinée à s'appliquer à toutes les opérations de ce chemin. Vous pouvez utiliser la syntaxeCommonMark pour la représentation de texte enrichi.
Si vous créez un nouveau chemin, cliquez sur Créer.
Les détails du chemin s'affichent pour être édités plus en détail, comme décrit à l'étape 4.
Cliquez sur Sauvegarder lorsque vous avez terminé.