Configurer le bouton « Test it »

Vous pouvez configurer le bouton « Test It » 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 « Test it »

Vous pouvez masquer le bouton « Test it » de vos endpoints en ajoutant x-hideTryItPanel à un endpoint, ou à la racine de votre spécification OpenAPI.

openapi.yaml

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

Proxy des requêtes « Test it »

Certaines API bloquent les requêtes depuis le navigateur, souvent à cause du CORS.

Acheminer Test it le trafic via GitBook en ajoutant x-enable-proxy à votre spécification.

Voir Utilisation du proxy OpenAPI pour des exemples.

Activer l'authentification dans la fenêtre de test

Le moteur d'exécution des requêtes ne peut présenter et appliquer l'auth que si votre spécification la déclare. Définissez les 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

Ci‑dessous se trouvent des modèles courants. Utilisez des guillemets droits en YAML.

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

openapi: '3.0.3'
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: 'https://auth.example.com/oauth/authorize'
          tokenUrl: 'https://auth.example.com/oauth/token'
          scopes:
            read:items: 'Lire les éléments'
            write:items: 'Écrire les éléments'

Appliquer les schémas globalement ou par opération

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

Contrôler l'URL de l'endpoint 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.

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

servers:
  - url: https://{instance}.api.{region}.example.cloud
    variables:
      instance:
        default: acme
        description: Votre tenant ou identifiant d'instance
      region:
        default: eu
        enum:
          - eu
          - us
          - ap
        description: Déploiement régional

Mis à jour il y a 7 jours

Ce contenu vous a-t-il été utile ?

Bonjour

hashtagMasquer le bouton « Test it »

hashtagProxy des requêtes « Test it »

hashtagActiver l'authentification dans la fenêtre de test

hashtagDéclarez votre schéma d'authentification

hashtagAppliquer les schémas globalement ou par opération

hashtagContrôler l'URL de l'endpoint avec servers