Laravel स्वचालित रूप से एपीआई दस्तावेज़ तैयार करें Swagger

Swagger स्वचालित रूप से एपीआई दस्तावेज़ तैयार करने जैसे टूल का उपयोग करना Laravel आपके एपीआई के लिए दस्तावेज़ बनाने और बनाए रखने का एक सुविधाजनक तरीका है। Swagger एक ओपन-सोर्स टूल है जो आपके एपीआई का वर्णन, दस्तावेज़ीकरण और परीक्षण करने में आपकी सहायता करता है। यहां बताया गया है कि आप एपीआई दस्तावेज़ तैयार करने के लिए Swagger इसका उपयोग कैसे कर सकते हैं: Laravel

चरण 1: Swagger के लिए इंस्टॉल करें Laravel

Swagger package के लिए इंस्टॉल करने के लिए कंपोज़र का उपयोग करें Laravel. package इस उद्देश्य के लिए एक लोकप्रिय है darkaonline/l5-swagger.

composer require "darkaonline/l5-swagger:~9.0"

चरण 2: कॉन्फ़िगर करें Swagger

स्थापना के बाद, आपको दस्तावेज़ को अपने एप्लिकेशन की निर्देशिका Swagger में प्रकाशित करना होगा। आप कमांड चलाकर ऐसा कर सकते हैं: public Laravel Artisan

php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

config/l5-swagger.php फिर, आपको अपने एप्लिकेशन को कॉन्फ़िगर करने के लिए कॉन्फ़िगरेशन फ़ाइल को संपादित करने की आवश्यकता है Swagger, जिसमें उस स्थान को निर्दिष्ट करना शामिल है जहां दस्तावेज़ प्रकाशित किया जाएगा।

चरण 3: उपयोग करें Annotations

अपने एप्लिकेशन annotations में अपने मार्गों के दस्तावेज़ीकरण का वर्णन करने के लिए उपयोग करें । Laravel इनका annotations उपयोग Swagger स्वचालित रूप से एपीआई दस्तावेज़ तैयार करने के लिए किया जाता है। उदाहरण के लिए:

/**  
 * @OA\Get(  
 *      path="/api/users",  
 *      operationId="getUsersList",  
 *      tags={"Users"},  
 *      summary="Get list of users",  
 *      description="Returns list of users",  
 *      @OA\Response(  
 *          response=200,  
 *          description="Successful operation",  
 *          @OA\JsonContent()  
 *      )  
 *)  
 */  

चरण 4: ट्रू कैप ताई लिउ एपीआई Swagger

यहाँ क्लिक करें और देखें कि क्या सच है, एपीआई के लिए यूआरएल डाउनलोड करें मुझे लगता है कि यह मेरे लिए बहुत अच्छा है Swagger । बस इतना ही, यूआरएल अभी भी उपलब्ध नहीं है http://your-app-url/api/documentation ।

Swagger एक दिन में एक बार जब आप रूट पर जाते हैं तो आपको एक रास्ता मिल जाता है, जो आपको एक अच्छा रास्ता दिखाता है।

Swagger आपके पास Laravel एक एपीआई होना चाहिए जो आपके लिए पर्याप्त हो और आपके लिए एक अच्छा विकल्प हो ।