Müqavilələrin versiyası

Müqavilələrin versiyası

API aktiv şəkildə inkişaf etdikdə, versiyaların uyğunluğunu qorumaq və bir dəyişikliyin onlarla müştəri inteqrasiyasını pozduğu vəziyyətlərdən qaçmaq vacibdir. Biz dəyişmələrə nəzarət etmək və istifadəçilər üçün risk olmadan API-ni rəvan yeniləməyə imkan verən müqavilələrin tam versiyasını həyata keçiririk.

Mikroservis arxitekturasında, B2B inteqrasiyasında və müxtəlif müştərilərin müxtəlif interfeys versiyalarından istifadə etdikləri açıq API məhsullarında bu çox vacibdir.

Biz nə versiyası

Obyekt	Təsvir
OpenAPI spesifikasiyası	Sənədlərin və müqavilənin hər versiyasını saxlayırıq
Endpoint's	URL-ə versiyalar əlavə edin ('/v1/', '/v2/'), backward compatibility saxlayın
Müqavilələr (Pact, Dredd)	Müştəri və server arasında qarşılıqlı əlaqə şərtlərinin müəyyənləşdirilməsi
Data modelləri	Sorğu və cavab strukturunda dəyişikliklərə nəzarət

Necə həyata keçiririk

Paralel olaraq bir neçə API versiyasını dəstəkləyir
URL-lərdə, başlıqlarda və ya parametrlərdə açıq versiyanın göstərilməsi
Müqavilələrin hər bir versiyasının avtomatlaşdırılması (Pact, Postman, Jest, Dredd)
Git və ya CI/CD vasitəsilə spesifikasiya versiyası
Hər dəyişiklik zamanı müştərilər üçün sənədləşmə və changelog

Üstünlüklər

Zəmanətli inteqrasiya sabitliyi
Müştəriləri «sındırmaq» riski olmadan yeni xüsusiyyətlər buraxmaq imkanı
Versiyalar arasında miqrasiyanın sadələşdirilməsi
Dəqiq dəyişiklik tarixi və müqavilələrə nəzarət
Xarici və daxili inkişaf komandaları üçün şəffaflıq

Harada xüsusilə vacibdir

Bir çox asılılığı olan mikroservis arxitekturası
ictimai və ya B2B API ilə platformalar
Uzunmüddətli müqavilələrlə maliyyə və ödəniş sistemləri
Sabit API interfeysindən asılı mobil tətbiqlər

Müqavilələrin versiyalaşdırılması API-də proqnozlaşdırıla bilən və etimadın əsasını təşkil edir. Biz bütün tərəflər üçün uyğunluq və şəffaflığı qoruyaraq, ağrısız API-lərin dəyişdirilməsinə və inkişafına imkan verən prosesləri həyata keçiririk.