OpenAPI / Swagger വ്യൂവർ

OpenAPI സ്പെസിഫിക്കേഷനുകൾ ദൃശ്യവൽക്കരിക്കുകയും പരിശോധിക്കുകയും ചെയ്യുക.

OpenAPI / Swagger വ്യൂവർ — വിശദമായ ഗൈഡ്

RESTful API കോൺട്രാക്ടുകൾ പരിശോധിക്കുന്നതിനുള്ള ഒരു ക്ലയന്റ്-സൈഡ് ഡോക്യുമെന്റേഷൻ റീഡറാണ് OpenAPI Viewer. ലോക്കൽ Swagger UI ഇൻസ്റ്റാളേഷനുകളോ ക്ലൗഡ് ഡിപൻഡൻസികളോ ഇല്ലാതെ തന്നെ ഇത് JSON അല്ലെങ്കിൽ YAML ഫോർമാറ്റിലുള്ള Swagger 2.0, OpenAPI 3.0 / 3.1 സ്പെസിഫിക്കേഷനുകൾ റെൻഡർ ചെയ്യുന്നു.

ഇത് എല്ലാ എൻഡ്‌പോയിന്റുകൾക്കുമായി ചിട്ടപ്പെടുത്തിയ സൈഡ്‌ബാർ നാവിഗേഷൻ നൽകുന്നു; ഇതിലൂടെ പാതകൾ (paths), HTTP മെത്തേഡുകൾ (GET, POST, PUT, DELETE), ഹെഡർ പാരാമീറ്ററുകൾ, ക്വറി സ്ട്രിംഗുകൾ, ഘടനാപരമായ റിക്വസ്റ്റ് ബോഡികൾ, HTTP റെസ്‌പോൺസ് കോഡുകൾ, ഡാറ്റാ സ്കീമകൾ എന്നിവ പ്രദർശിപ്പിക്കുന്നു.

#openapi #swagger #api #docs #rest #yaml #json

പ്രധാന സവിശേഷതകളും കഴിവുകളും

  • JSON, YAML എന്നിവയിലുള്ള Swagger 2.0, OpenAPI 3.0 / 3.1 സ്പെസിഫിക്കേഷനുകൾ പിന്തുണയ്ക്കുന്നു
  • വിഭാഗീകരിച്ച എൻഡ്‌പോയിന്റുകൾ, HTTP മെത്തേഡുകൾ, സ്റ്റാറ്റസ് കോഡുകൾ എന്നിവ കാണിക്കുന്ന ഇന്ററാക്ടീവ് സൈഡ്‌ബാർ
  • നെസ്റ്റഡ് ഡാറ്റാ മോഡലുകളും പ്രോപ്പർട്ടി നിയന്ത്രണങ്ങളും പ്രദർശിപ്പിക്കുന്ന ഡീപ് `$ref` സ്കീമ റെസല്യൂഷൻ
  • പ്രൊപ്രൈറ്ററി എന്റർപ്രൈസ് API കോൺട്രാക്ടുകൾ സുരക്ഷിതമായി സൂക്ഷിക്കുന്ന 100% ക്ലയന്റ്-സൈഡ് ഓഫ്‌ലൈൻ പാർസിംഗ്

ഉപയോഗിക്കേണ്ട വിധം

  1. 1

    നിങ്ങളുടെ `swagger.json` അല്ലെങ്കിൽ `openapi.yaml` ടെക്സ്റ്റ് പേസ്റ്റ് ചെയ്യുക, അല്ലെങ്കിൽ സ്പെക് ഫയൽ നേരിട്ട് അപ്‌ലോഡ് ചെയ്യുക.

  2. 2

    ഇന്ററാക്ടീവ് വ്യൂവറിൽ റെൻഡർ ചെയ്ത ഘടനാപരമായ API ഡോക്യുമെന്റേഷൻ ബ്രൗസ് ചെയ്യുക.

  3. 3

    റിക്വസ്റ്റ് ഹെഡറുകൾ, റിക്വസ്റ്റ് പേലോഡ് സ്കീമകൾ, റെസ്‌പോൺസ് സാമ്പിളുകൾ എന്നിവ പരിശോധിക്കാൻ ഏതെങ്കിലും എൻഡ്‌പോയിന്റ് വിപുലീകരിക്കുക (expand ചെയ്യുക).

സാധാരണ ഉപയോഗങ്ങൾ

  • → പ്രത്യേക Swagger UI സെർവർ സജ്ജീകരിക്കാതെ തന്നെ ബാക്കെൻഡ് API നിർവചനങ്ങൾ ഓഡിറ്റ് ചെയ്യൽ
  • → സ്വമേധയാ എഴുതിയ OpenAPI സ്പെസിഫിക്കേഷനുകളിൽ അസാധുവായ `$ref` പോയിന്ററുകൾ ഉണ്ടോയെന്ന് പരിശോധിച്ച് ഉറപ്പുവരുത്തൽ
  • → API ഇന്റഗ്രേഷൻ വേളയിൽ ഫ്രണ്ട്‌എൻഡ് എഞ്ചിനീയർമാർക്ക് കൃത്യമായ സ്കീമ റഫറൻസുകൾ നൽകൽ

ബന്ധപ്പെട്ട ടൂളുകൾ

പതിവ് ചോദ്യങ്ങളും സ്വകാര്യതയും

ഈ ടൂളിന് YAML സ്പെസിഫിക്കേഷനുകൾ നേരിട്ട് വായിക്കാൻ കഴിയുമോ?

അതെ. ഉൾച്ചേർത്ത ഒരു YAML പാർസർ ബ്രൗസറിനുള്ളിൽ തന്നെ `.yaml`, `.json` OpenAPI കോൺട്രാക്റ്റ് സ്പെസിഫിക്കേഷനുകൾ പൂർണ്ണമായി പ്രോസസ്സ് ചെയ്യുന്നു.

എന്റെ പ്രൊപ്രൈറ്ററി API സ്പെസിഫിക്കേഷൻ ബാഹ്യ സെർവറുകളിലേക്ക് അപ്‌ലോഡ് ചെയ്യപ്പെടുമോ?

ഇല്ല. എല്ലാ ഡോക്യുമെന്റ് പാർസിംഗും സ്കീമ റെൻഡറിംഗും നിങ്ങളുടെ ലോക്കൽ ബ്രൗസർ മെമ്മറിയിൽ മാത്രമാണ് പ്രവർത്തിക്കുന്നത്.