Utilisation du proxy OpenAPI

GitBook peut faire office de proxy Testez-le les requêtes afin qu'elles fonctionnent même lorsque votre serveur d'API ne prend pas en charge CORS.

Pourquoi cela existe

Les navigateurs bloquent les requêtes cross-origin à moins que le serveur d'API n'accepte via des en-têtes CORS. Sans CORS configuré, Testez-le les requêtes échouent dans le navigateur. Le proxy achemine ces requêtes côté serveur via GitBook, contournant cette restriction.

Activer le proxy pour l'ensemble de votre spécification

Ajouter x-enable-proxy: true à la racine de votre spécification OpenAPI.

openapi: '3.0.3'
x-enable-proxy: true
info :
  title : Exemple d'API
  version : '1.0.0'
servers :
  - url : https://api.example.com

Activer ou désactiver pour une opération spécifique

Ajouter x-enable-proxy sur une opération.

openapi: '3.0.3'
info :
  title : Exemple d'API
  version : '1.0.0'
servers :
  - url : https://api.example.com
paths :
  /reports :
    get :
      summary : Lister les rapports
      x-enable-proxy: true
      responses :
        '200':
          description : OK
    post :
      summary : Créer un rapport
      x-enable-proxy: false
      responses :
        '201':
          description : Créé

Le niveau opération x-enable-proxy prime sur la valeur au niveau racine.

Ce que le proxy prend en charge

GitBook transmet tous les HTTP méthodes (GET, POST, PUT, DELETE, PATCH), les en-têtes, les cookies et les corps de requête.

Sécurité

Le proxy ne transmet les requêtes qu'aux URL listées dans le servers tableau de votre spécification. Il ne peut pas être utilisé pour atteindre des URL arbitraires.

Assurez-vous que votre servers tableau inclut chaque URL de base contre laquelle vous souhaitez tester. Si une URL n'est pas listée, Testez-le les requêtes vers cet hôte contourneront le proxy.