Swagger Hinzufügen von benutzerdefinierten Attributen zu Parameterdefinition

Question

Wir haben eine Python-Web-Server-App auf Connexion und Flask-Bibliotheken. Für Prüfzwecke drucken wir jede Anfrage, einschließlich Anfragetext, in die Protokolle. Diese Protokolle sind viel umfangreicher als das, was Flask standardmäßig druckt.

Allerdings gibt es Parameter wie Passwörter oder Schlüssel, die ich nicht ihre Werte in den Protokollen drucken möchten.

Ich möchte benutzerdefinierte Parameter zu mehreren Parametern 'Definition in swagger.yml so auf Web-App Start-up Ich werde Parameter Definitionen von Connexion und speichern Sie alle Parameter, die dieses benutzerdefinierte Attribut haben, so später werde ich Werte verstecken dieser Parameter in den Protokollen.

Meine gewünschte Definition:

paths: 
 
    /demo_add_user: 
 
    post: 
 
     summary: "add user" 
 
     operationId: api.api.demo_add_user 
 
     parameters: 
 
     - name: "new_user" 
 
      in: body 
 
      required: true 
 
      description: "Use to add" 
 
      schema: 
 
      $ref: "#/definitions/NewUser" 
 
     - name: "password" 
 
      in: body 
 
      description: "user password" 
 
      required: false 
 
      type: string 
 
      x-hidden: true 
 
     responses: 
 
...

Natürlich, ich würde connexion mag dieses Attribut zu ignorieren, da dies zu unserer Implementierung spezifisch ist. Jede Möglichkeit, benutzerdefinierte Parameter wie x-hidden zur Parameterdefinition hinzuzufügen?

Answer 1

Die Lösung besteht darin, OpenApi-Erweiterungen zu verwenden, indem Sie das Attribut x-attr hinzufügen.

Die Details werden in der nächsten Link: https://swagger.io/specification/#specificationExtensions