Toparlar ýa-da daşarky hyzmatdaşlar arasynda API bilen işleşende, soraglaryň we jogaplaryň formatynyň öňünden aýdyp boljak bolmagy aýratyn möhümdir. Şertnamalaýyn synag iki tarapyň - müşderiniň we serweriň alyş-çalyş gurluşyna razydygyny we täzelenmeler geçirilende ony bozmaýandygyny barlamaga mümkinçilik berýär.
API resminamalaryna ýa-da sarp edijiniň garaşýan zatlaryna laýyklygyny awtomatiki barlaýan şertnama synaglaryny girizýäris - önümçilige girmezden ozal.
API-de şertnama näme
- Haýsy meýdançalarda haýyş we jogap bar
- Haýsy maglumat formatlary kabul ederlikli
- Haýsy status kodlary yzyna gaýtarylýar
- Haýsy hökmany parametrler talap edilýär
Şertnamanyň bozulmagy = müşderiniň ýa-da hyzmatyň tarapynda bolup biljek şowsuzlyk.
Bu nähili işleýär
| Tarap | Näme barlanýar |
|---|---|
| Üpjün ediji (API) | API jogap gurluşy boýunça müşderiniň garaşýan zatlaryna laýyk gelmelidir |
| Müşderi (consumer) | Müşderi belli bir shema garaşýar - synag onuň berjaý edilendigini barlaýar |
| Bidirectional | Ikitaraplaýyn synag: müşderi hem, serwer hem şertnama bilen ylalaşýar |
Ulanylýan gurallar: Pact, Spring Cloud Contract, Dredd, Postman Contract Tests.
Şertnama synagynyň artykmaçlyklary
Deploýdan öň gapma-garşylyklary ýüze çykarmak
Müşderileri bozýan "sessiz" üýtgeşmelerden goramak
API wersiýalaryny howpsuz täzelemek
Ösüş toparlarynyň arasynda ynamy artdyrmak
Şertnamalardaky üýtgeşmeleriň taryhyny ýazga almak
Nädip durmuşa geçirýäris
OpenAPI/Pact şertnamalary
CI-Her komita üçin awtomatiki synaglar bilen integrasiýa
Wizualizasiýa we şertnamalaryň üýtgemeginiň taryhy
Çarşenbe bölünişi (staging/production)
Daşarky integratorlar üçin şertnamalary çap etmek
Bu ýerde aýratyn möhümdir
Bölünen jogapkärçiligi bolan mikroservisler
Daşarky B2B integrasiýalary bolan platformalar
Birnäçe garaşsyz toparlar tarapyndan API üstünde işlemek
Ýalňyşlyk ýol berilmeýän möhüm ulgamlar (maliýe, döwlet hyzmatlary)
Şertnama synagy serwer bilen müşderiniň arasynda ygtybarly köpri bolup durýar. Hiç bir täzelenme integrasiýany bozmaýan we garaşylmadyk bökdençlikler getirmeýän prosesi gurmaga kömek ederis.