स्वैगर संपादक में कुकीज़ का उपयोग कैसे करें

Question

मैं एक एपीआई दस्तावेज और परीक्षण करना चाहता हूं, जो http://editor.swagger.io/ में कुकी आधारित स्वामित्व का उपयोग करता है। एक साधारण उदाहरण देने के लिए: निम्नलिखित वाईएएमएल में कैसे लिखें, कि/लॉगिन एक्शन एक कुकी बनाता है और कुकी को/MyMecrecretStuff को दिखाने के लिए पास किया जाना है?

swagger: '2.0' 
info: 
    title: Test API 
    version: '1' 
host: my.test.com 
schemes: 
    - https 
basePath:/
consumes: 
    - multipart/form-data 
produces: 
    - application/json 
paths: 
    /login: 
    post: 
     parameters: 
     - name: username 
      in: formData 
      required: true 
      type: string 
     - name: password 
      in: formData 
      required: true 
      type: string 
      default: secret 
     responses: 
     200: 
      description: OK 
    /showMySecretStuff: 
    get: 
     responses: 
     200: 
      description: OK 

Answer 1

कुकी प्रमाणीकरण OpenAPI 3.0 में समर्थित है लेकिन ओपनएपीआई/स्वैगर 2.0 में नहीं है।

OpenAPI 3.0 में, कुकी प्रमाणीकरण एक API कुंजी in: cookie भेज दिया जाता है कि के रूप में परिभाषित किया गया है:

openapi: 3.0.0 
... 

components: 
    securitySchemes: 
    cookieAuth: 
     type: apiKey 
     in: cookie 
     name: COOKIE-NAME # replace with your cookie name 

paths: 
    /showMySecretStuff: 
    get: 
     security: 
     - cookieAuth: [] 
     responses: 
     '200': 
      description: OK 

लॉगिन आपरेशन किसी भी तरह से securitySchemes से जुड़ा हुआ नहीं है, लेकिन आप प्रतिक्रिया हेडर को परिभाषित करने के लिए कर सकते हैं Set-Cookie प्रलेखन प्रयोजनों के लिए:

paths: 
    /login: 
    post: 
     requestBody: 
     ... 
     responses: 
     '200': 
      description: OK 
      headers: 
      Set-Cookie: 
       description: > 
       Contains the session cookie named `COOKIE-NAME`. 
       Pass this cookie back in subsequent requests. 
       schema: 
       type: string 

जिसके अनुसार, स्वैगर संपादक और स्वैगर यूआई वर्तमान में कुकी प्रमाणीकरण का समर्थन नहीं करते। अपडेट के लिए OAS 3.0 Support Backlog देखें।