Configuration du bouton « Tester »

Vous pouvez configurer le bouton « Testez-le » et la fenêtre associée dans GitBook en utilisant plusieurs extensions OpenAPI. Ces extensions peuvent aider à améliorer et configurer la suite de tests pour les utilisateurs.

Masquer le bouton « Testez-le »

Vous pouvez masquer le bouton « Testez-le » de vos points de terminaison en ajoutant le x-hideTryItPanel à un point de terminaison, ou à la racine de votre spécification OpenAPI.

openapi.yaml

openapi : '3.0'
info : ...
tags : [...]
paths :
  /example :
    get :
      summary : Résumé de l'exemple
      description : Description de l'exemple
      operationId : examplePath
      responses : [...]
      parameters : [...]
      x-hideTryItPanel : true

Activer l'authentification dans la fenêtre de test

Le moteur d'exécution des requêtes ne peut présenter et appliquer l'authentification que si votre spécification la déclare. Définissez des schémas sous components.securitySchemes, puis attachez-les soit globalement via security (s'applique à toutes les opérations) ou par opération (remplace le global).

Déclarez votre schéma d'authentification

Voici des modèles courants. Utilisez des guillemets droits en YAML.

HTTP Bearer (par exemple, JWT)

openapi : '3.0.3'
components :
  securitySchemes :
    bearerAuth :
      type : http
      scheme : bearer
      bearerFormat : JWT

Clé API dans l'en-tête

OAuth2 (authorizationCode)

Appliquer les schémas globalement ou par opération

Global

openapi : '3.0.3'
security :
  - bearerAuth : []
paths : ...

Par opération

Contrôler l'URL du point de terminaison avec servers

Le moteur d'exécution des requêtes cible l'URL (ou les URL) que vous définissez dans le servers tableau. Déclarez un ou plusieurs serveurs ; vous pouvez également les paramétrer avec des variables.

Serveur unique

openapi : '3.0.3'
servers :
  - url : https://instance.api.region.example.cloud

Serveurs multiples

Variables de serveur

Serveurs par opération