Configuration du bouton « Tester »

Vous pouvez configurer le bouton « Test It » et la fenêtre associée dans GitBook à l’aide de plusieurs extensions OpenAPI. Ces extensions peuvent aider à améliorer et à configurer la suite de test pour les utilisateurs.

Masquer le bouton « Test it »

Vous pouvez masquer le bouton « Test it » de vos points de terminaison en ajoutant 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: Exemple de résumé
      description: Exemple de description
      operationId: examplePath
      responses: [...]
      parameters: [...]
      x-hideTryItPanel: true

Acheminer les requêtes « Test it » via un proxy

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

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

Voir Utiliser le proxy OpenAPI pour des exemples.

Activer l’authentification dans la fenêtre de test

Le moteur de requêtes ne peut présenter et appliquer l’authentification que si votre spécification la déclare. Définissez les schémas sous components.securitySchemespuis associez-les soit globalement via security (s’applique à toutes les opérations), soit par opération (remplace la valeur globale).

Déclarez votre schéma d’authentification

Voici des modèles courants. Utilisez des guillemets droits dans 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 des éléments'

Appliquer les schémas globalement ou par opération

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

Contrôler l’URL du point de terminaison avec `tableau servers`

Le moteur de requêtes cible l(es) URL(s) que vous définissez dans le tableau 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: Le slug de votre locataire ou de votre instance
      region:
        default: eu
        enum:
          - eu
          - us
          - ap
        description: Déploiement régional

Mis à jour il y a 1 mois

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