API-ni başa düşmək, tətbiq etmək və dəstəkləmək üçün keyfiyyətli sənədlər vacibdir. Ən populyar iki API vizualizasiya aləti olan Swagger UI və Redoc ilə OpenAPI spesifikasiyalarına əsaslanan sənədlərin avtomatik istehsalını konfiqurasiya edirik.
Bu, inkişaf etdiricilərə metodların strukturunu öyrənmək, sorğuları sınaqdan keçirmək və tez bir zamanda API-yə qoşulmaq üçün interaktiv interfeys təqdim etməyə imkan verir.
Sənədlərə nə daxildir
| Bölmə | Təsvir |
|---|---|
| Endpoint 's və metodları | Marşrutların tam siyahısı, HTTP metodları, parametrləri, başlıqları |
| Sorğu/cavab nümunələri | Curl, Postman, JavaScript, Python və digər dillər üçün ssenarilər |
| Avtorizasiya | JWT, OAuth2, API Key birbaşa interfeysdən dəstək |
| Obyektlərin sxemləri | Modellərin, daxili strukturların və məlumat tələblərinin təsviri |
| Səhv kodları | Bütün mümkün statuslar |
Istifadə etdiyimiz alətlər
Swagger UI - brauzerdə interaktiv sənədləşmə, test imkanı
Redoc - saytda nəşr üçün ideal oxunaqlı, statik interfeys
OpenAPI 3. 0/3. 1 - hər şeyin qurulduğu spesifikasiya formatı
Koddan avtogenerasiya - avtomatik olaraq sənədlərin şərhi, təsviri, versiyası və yenilənməsi
JSON/YAML/HTML-ə ixrac
Komanda və tərəfdaşlar üçün üstünlüklər
Yeni inkişaf etdiricilərin onbordinq sürətləndirilməsi
İnteqrasiya zamanı səhvlərin sayının azaldılması
Həmişə aktual, kodla sinxronlaşdırılmış sənədlər
Texniki dəstək olmadan inteqrasiyanın sürətli başlaması
Sənədlərin ictimai və ya özəl portallarda yayımlanması asandır
Harada xüsusilə vacibdir
Xarici inkişaf etdiricilər üçün açıq API
Aktiv inkişaf ilə daxili API
B2B inteqrasiyası və SDK platformaları
Sxemlərin tənzimlənməsi və validasiyası tələb olunan xidmətlər
Swagger və Redoc yeni nəsil API sənədləşmə standartıdır. Hər hansı bir inkişaf etdiricinin bir neçə dəqiqə ərzində API ilə inteqrasiyaya başlaması üçün sənədlərin yaradılmasını, yenilənməsini və yayımlanmasını tənzimləyəcəyik.