5.7.1. Présentation de l'interface API
d'afficher la liste par thème des endpoints existants
de pouvoir filtrer cette liste
de connaître toutes les informations de chaque endpoint
d'exécuter le endpoint,
de connaître sa commande curl
de connaître sa requête URL
Note
L'interface graphique API est nommée swagger.
L'accès à cette interface est disponible dans le barre de titre de l'interface principale.
`API`
de la barre de titre, l'écran suivant est affiché.Repère |
Description |
---|---|
1 |
|
2 |
Nom du compte courant : ici compte administrator |
3 |
Bouton |
4 |
Bouton |
5 |
Les endpoints sont triés par thème (tag) |
6 |
Champ de filtration : permet de filtrer les thèmes |
Note
Une fonctionnalité nécessitant des droits administrateurs ne pourra être utilisée par un utilisateur n'ayant que les droits opérateurs.
5.7.1.1. Détail pour un endpoint
Les informations affichées pour un endpoint sont les suivantes :
Repère |
Description |
---|---|
1 |
Ligne de titre. Elle comprend l'action (ici GET), le nom du endpoint (ici /api/gcaps), les accès (ici Administrators et Opertors), la description du endpoint |
2 |
Bouton |
8 |
Zone
`Parameters` : affiche les paramètres optionnelles ou obligatoires pour exécuter la requête. Pour connaître les paramètres obligatoires, se référer à la zone (6).Cette zone comprend les paramètres nécessaire à l'API sélectionné. Dans cet exemple, il y en a deux : le numéro de pages et le nombre de résultats par page.
|
7 |
|
6 |
Zone |
Note
Si un paramètre est obligatoire, un astérisque avec indication `required`
est affiché.
Note
Dans cet écran, il n'est pas possible de saisir les paramètres. Pour cela, il faut exécuter la requête.
5.7.1.1.1. Zone `Responses`
si le bouton `Try it out`
est non activé
Si le bouton `Try it out`
est non activé alors la zone `Responses`
contient les informations de la réponse attendue :
Repère |
Description |
---|---|
5 |
lien |
4 |
lien
`Example Value` : en cliquant sur ce texte, la fenêtre (3) affiche un exemple de la réponse attendue avec des valeurs pour exemple.Les valeurs sont, pour le type integer (valeur 0), pour le type string (valeur = string), pour le type boolean (valeur = true)
|
3 |
Champ de visualisation : contient le contenu sélectionné par l'option active (4) ou (5).
Un exemple de contenu est donné ci dessous.
|
5.7.1.1.1.1. Exemple de modèle de sortie
Le modèle de sortie donne la structure des données qui seront affichées en sortie donc après exécution de la requête.
Repère |
Description |
---|---|
1 |
|
2 |
|
3 |
`GcapReadOnly` : Paramètres du GCap.Pour chaque paramètre (id, fqdn,is_paired...), les caractéristiques sont affichées
|
5.7.1.1.2. Exemple avec des valeurs par défaut
Dans cet exemple, les informations sont affichées avec les valeurs par défaut suivantes :
les paramètres de type integer sont affichés avec le nombre
`0`
les paramètres de type string sont affichés avec le texte
`string`
les paramètres de type booléen sont affichés avec le texte
`true`
Le repérage est le même que dans le modèle de sortie.
5.7.1.1.3. Zone `Responses`
si le bouton `Try it out`
est activé
`Try it out`
, la zone de saisie des paramètres est activée.Repère |
Description |
---|---|
1 |
Bouton |
2 |
Bouton |
3 |
La zone |
Après avoir cliqué sur le bouton `Execute`
, la requête est lancée et la fenêtre suivante est affichée.
Repère |
Description |
---|---|
1 |
Bouton |
2 |
Zone d'affichage |
3 |
Zone d'affichage |
4 |
Zone d'affichage |
5 |
|
6 |
|
7 |
|
8 |
|