Zinn Digital tərəfindən satılır
Yeni mühəndislərin dəstəyə ehtiyac duymadan problemsiz inteqrasiya etməsinə imkan verən, birbaşa kodunuzdan yazılmış və tərtibatçılar tərəfindən sınaqdan keçirilmiş API sənədləri.
Əksər API sənədlərinin axsayan tərəfi
Bir çox təlimat son nöqtələri (endpoints) sadalayır, lakin əslində çaşqınlıq yaradan təfərrüatları kənarda qoyur: autentifikasiyanın praktikada necə işləməsi, dəqiq sorğu və cavab nümunələri, konkret xətaların nə mənaya gəlməsi və onların necə həll edilməsi. Bu baş verdikdə tərtibatçılar dəstək sorğuları göndərməyə məcbur olurlar ki, bu da sənədləşmənin mövcudluq məqsədini heçə endirir.
Yanaşmamız
Fərziyyələrə güvənmək əvəzinə, birbaşa sizin mənbə kodunuz əsasında qururuq. API-ni canlı giriş məlumatlarından istifadə edərək özümüz sınaqdan keçirməzdən əvvəl marşrutlarınızı, doğrulama məntiqinizi və xətaların idarə edilməsini araşdırırıq. Yekun sənəddəki hər bir nümunə göndərdiyimiz real sorğunu və aldığımız cavabı əks etdirir, bu da heç bir uydurma təfərrüatın və ya qeyri-mümkün status kodlarının olmamasını təmin edir.
Nə əldə edəcəksiniz
Təhvil formatı
Repozitoriyanıza uyğun, komandanızın hansını yeniləyəcəyindən asılı olaraq OpenAPI-yə və ya sənədləşmə saytına uyğunlaşdırılmış şəkildə strukturlaşdırılmış Markdown təqdim edirik. Kod nümunələri istifadəçilərinizin arxalandığı dillərdə təmin edilir və icra olunaraq sınaqdan keçirilir. İstəyə əsasən Postman tipli kolleksiya da daxil edilə bilər.
Sizdən nə tələb olunur
Repozitoriyanıza və ya OpenAPI faylınıza giriş imkanı, sınaq mühiti üçün işlək giriş məlumatı və dəstək heyətinizin ən çox cavablandırdığı suallar - bunlar təlimatın strukturunu formalaşdırır.
Nələr daxil deyil
Bu xidmət proqram təminatının necə işlədiyinə dair dəqiq texniki sənədləşməni əhatə edir; təşviqat və ya marketinq mətni isə ayrıca bir tapşırıqdır.
Proses və müddət
Dəstək komandanızın cavablandırdığı təkrarlanan suallarla müqayisə edə biləcəyiniz tam bir ilkin qaralama alacaqsınız. Cilalanmış, lakin qeyri-dəqiq bir iş təhvil verməkdənsə, bir mühəndisin nadir rast gəlinən halları (edge cases) erkən qeyd etməsini üstün tuturuq. Hər bir nümunə canlı API-niz üzərində işə salındığı üçün yekun sənəddə heç bir nəzəri məlumat olmur.
Bu paket bir baxış mərhələsi ilə tək bir keçiddə çatdırılan, 500.99 USD dəyərində və 10 günlük icra müddətinə malik sabit qiymətli bir API sənədləşdirmə həcmini əhatə edir. Sifarişin aid olduğu domeni və təlimatınızı təqdim etməyiniz lazımdır.
$ 500.99
Və ya bugünkü məzənnə ilə € 447.01 · £ 374.42 ödəyin — onu səbətinizə əlavə etdiyiniz zaman məzənnə sabitləşir.
One fixed-price scope, delivered in one pass: API Documentation. - 1 revision
10 gün ərzində çatdırılır
Daxil olan düzəlişlər: 0
Əvvəlcədən hesaba ehtiyac yoxdur — hesabınız ödəniş zamanı yaradılır. Siz işi qəbul edənə qədər vəsaiti saxlayırıq.
Bəli - sənədlərdə göstərilən hər bir sorğu real mühitdə icra edilmişdir, yəni nümunələr nəzəri dizaynı deyil, proqram təminatının faktiki davranışını göstərir.
Biz əsasən repozitoriyanızın daxilində Markdown təqdim edirik, həmçinin müşayiət edən arayış materialı ilə birlikdə OpenAPI spesifikasiyası da təqdim edə bilərik. Hər iki seçim təhvil-təslimdən sonra sadə texniki xidməti təmin edir.
Bunlar tam şəkildə daxil edilmişdir - bura tokenin yaradılması, yenilənməsi, seanslar zamanı etibarlılıq müddətinin bitməsi ssenariləri və ümumi inteqrasiya çətinliklərinin arxasında duran əsas səbəblər daxildir.