OpenAPI / Swagger દર્શક વિશે — વિગતવાર માર્ગદર્શિકા
OpenAPI Viewer એ RESTful API કોન્ટ્રાક્ટ્સનું નિરીક્ષણ કરવા માટેનું ક્લાયન્ટ-સાઇડ ડોક્યુમેન્ટેશન રીડર છે. તે સ્થાનિક Swagger UI ઇન્સ્ટોલેશન અથવા ક્લાઉડ ડિપેન્ડન્સીની જરૂર વગર JSON અથવા YAML માં Swagger 2.0 અને OpenAPI 3.0 / 3.1 સ્પષ્ટીકરણો રેન્ડર કરે છે.
તે બધા એન્ડપોઇન્ટ્સ માટે સ્વચ્છ અને જૂથબદ્ધ સાઇડબાર નેવિગેશન પ્રદાન કરે છે, જેમાં પાથ, HTTP મેથડ્સ (GET, POST, PUT, DELETE), હેડર પેરામીટર્સ, ક્વેરી સ્ટ્રિંગ્સ, સ્ટ્રક્ચર્ડ રિક્વેસ્ટ બોડીઝ, HTTP રિસ્પોન્સ કોડ્સ અને ડેટા સ્કીમા દર્શાવવામાં આવે છે.
મુખ્ય સુવિધાઓ અને ક્ષમતાઓ
- JSON અને YAML માં Swagger 2.0 અને OpenAPI 3.0 / 3.1 સ્પષ્ટીકરણોને સપોર્ટ કરે છે
- વર્ગીકૃત એન્ડપોઇન્ટ્સ, HTTP મેથડ્સ અને સ્ટેટસ કોડ્સ દર્શાવતો ઇન્ટરેક્ટિવ સાઇડબાર
- નેસ્ટેડ ડેટા મોડેલ્સ અને પ્રોપર્ટી અવરોધો દર્શાવતું ડીપ `$ref` સ્કીમા રિઝોલ્યુશન
- 100% ક્લાયન્ટ-સાઇડ ઑફલાઇન પાર્સિંગ જે પ્રોપ્રાઇટરી એન્ટરપ્રાઇઝ API કોન્ટ્રાક્ટ્સને સુરક્ષિત રાખે છે
કેવી રીતે ઉપયોગ કરવો
- 1
તમારું `swagger.json` અથવા `openapi.yaml` લખાણ પેસ્ટ કરો, અથવા સ્પેક ફાઇલ સીધી અપલોડ કરો.
- 2
ઇન્ટરેક્ટિવ વ્યુઅરમાં રેન્ડર થયેલ સ્ટ્રક્ચર્ડ API ડોક્યુમેન્ટેશન બ્રાઉઝ કરો.
- 3
રિક્વેસ્ટ હેડર્સ, રિક્વેસ્ટ પેલોડ સ્કીમા અને રિસ્પોન્સ સેમ્પલ્સ તપાસવા માટે કોઈપણ એન્ડપોઇન્ટને વિસ્તૃત કરો.
સામાન્ય ઉપયોગના કિસ્સાઓ
- → સમર્પિત Swagger UI સર્વર સેટ કર્યા વિના બેકએન્ડ API વ્યાખ્યાઓનું ઓડિટ કરવું
- → અમાન્ય `$ref` પોઇન્ટર્સ માટે હાથથી લખેલા OpenAPI સ્પષ્ટીકરણોની સેનિટિ-ચકાસણી કરવી
- → API ઇન્ટિગ્રેશન દરમિયાન ફ્રન્ટએન્ડ એન્જિનિયરોને સચોટ સ્કીમા સંદર્ભો પૂરા પાડવા
સંબંધિત સાધનો
HTML મેટા ટેગ્સ જનરેટર
SEO અને સોશિયલ મીડિયા (Open Graph, Twitter Cards) માટે યોગ્ય HTML Meta Tags બનાવો.
.gitignore જનરેટર
Node, Python, Java, Go વગેરે માટે તૈયાર .gitignore રૂપરેખાંકનો બનાવો.
ઓપન સોર્સ લાયસન્સ જનરેટર
MIT, Apache 2.0, GPL વગેરે જેવા પ્રમાણભૂત ઓપન સોર્સ લાયસન્સ પસંદ કરો અને બનાવો.
README.md જનરેટર
પ્રોજેક્ટ્સ માટે વ્યાવસાયિક અને વિગતવાર README.md દસ્તાવેજીકરણ બનાવો.
Conventional Commits બિલ્ડર
પ્રમાણભૂત Conventional Commits સંદેશાઓ સરળતાથી બનાવો.
SemVer સંસ્કરણ કેલ્ક્યુલેટર
સિમેન્ટીક વર્ઝનિંગ (SemVer) ફોર્મેટ, શ્રેણીઓ અને સરખામણી તપાસો.
વારંવાર પૂછાતા પ્રશ્નો અને ગોપનીયતા
શું આ ટૂલ સીધા YAML સ્પષ્ટીકરણો વાંચી શકે છે?
હા. એમ્બેડેડ YAML પાર્સર બ્રાઉઝરમાં જ સંપૂર્ણપણે `.yaml` અને `.json` બંને OpenAPI કોન્ટ્રાક્ટ સ્પષ્ટીકરણોને પ્રોસેસ કરે છે.
શું મારું પ્રોપ્રાઇટરી API સ્પષ્ટીકરણ બાહ્ય સર્વર્સ પર અપલોડ થાય છે?
ના. તમામ ડોક્યુમેન્ટ પાર્સિંગ અને સ્કીમા રેન્ડરિંગ ફક્ત તમારા સ્થાનિક બ્રાઉઝર મેમરીમાં જ એક્ઝિક્યુટ થાય છે.