क्या है OpenAPI
REST API का वर्णन करने के लिए विनिर्देश
OpenAPI REST API का वर्णन करने के लिए एक मानक विनिर्देश है, जो स्वचालित दस्तावेज़ीकरण और कोड जनरेशन को सक्षम बनाता है।
OpenAPI के लाभ
- एकीकृत API विवरण मानक
- स्वचालित जनरेटेड दस्तावेज़ीकरण
- क्लाइंट कोड जनरेशन
- अनुरोध और प्रतिक्रिया सत्यापन
मुख्य घटक
- Info — API मेटाडेटा
- Paths — एंडपॉइंट और ऑपरेशन
- Components — पुन: प्रयोज्य स्कीमा
- Security — प्रमाणीकरण विधियाँ
- Servers — आधार URL
उपकरण
- Swagger UI — इंटरैक्टिव दस्तावेज़ीकरण
- Swagger Editor — विनिर्देश संपादक
- OpenAPI Generator — कोड जनरेशन
- Redoc — वैकल्पिक दस्तावेज़ीकरण