API- სთან მუშაობისას გუნდებსა და გარე პარტნიორებს შორის განსაკუთრებით მნიშვნელოვანია, რომ მოთხოვნისა და პასუხების ფორმატი პროგნოზირებადი დარჩეს. ხელშეკრულების ტესტირება საშუალებას გაძლევთ შეამოწმოთ, რომ ორივე მხარე - კლიენტი და სერვერი - ეთანხმებიან გაცვლის სტრუქტურას და არ არღვევენ მას განახლებების დროს.
ჩვენ ვატარებთ საკონტრაქტო ტესტებს, რომლებიც ავტომატურად ამოწმებენ API- ს შესაბამისობას დოკუმენტაციასთან ან მომხმარებლის მოლოდინებთან - წარმოების დაწყებამდე.
რა არის ხელშეკრულება API- ში
კონტრაქტი არის ხელშეკრულება, რომელიც განსაზღვრავს:- რა ველები შეიცავს თხოვნას და პასუხს
- რომელი მონაცემთა ფორმატებია მისაღები
- რა სტატუსის კოდები ბრუნდება
- რა სავალდებულო პარამეტრებია საჭირო
ხელშეკრულების დარღვევა = პოტენციური მარცხი კლიენტის ან მომსახურების მხარეზე.
როგორ მუშაობს
| მხარე | რა ტესტირება ხდება |
|---|---|
| პროვაიდერი (API) | API უნდა შეესაბამებოდეს კლიენტის მოლოდინს პასუხის სტრუქტურის შესახებ |
| კლიენტი | კლიენტი ელოდება გარკვეულ სქემას - ტესტი ამოწმებს, რომ იგი შეესაბამება |
| Bidirectional | ორმხრივი ტესტირება: როგორც კლიენტი, ასევე სერვერი ეთანხმებიან ხელშეკრულებას |
გამოყენებული ინსტრუმენტები: Pact, Spring Cloud Contract, Dredd, Postman Contract Tests.
კონტრაქტის ტესტირების უპირატესობები
შეუსაბამობების გამოვლენა
დაცვა „მშვიდი“ ცვლილებებისგან, რომლებიც არღვევს მომხმარებლებს
API ვერსიების უსაფრთხო განახლება
განვითარების გუნდებს შორის ნდობის ამაღლება
კონტრაქტების ცვლილების ისტორიის შეფასება
როგორ შევიტანოთ
ხელშეკრულებების განსაზღვრა OpenAPI/Pact ფორმატით
CI ინტეგრაცია ავტომატური ტესტის პროგონებთან თითოეული კომიტის დროს
კონტრაქტების ცვლილების ვიზუალიზაცია და ისტორია
ოთხშაბათს დაყოფა
კონტრაქტების გამოქვეყნება გარე ინტეგრატორებისთვის
სადაც განსაკუთრებით მნიშვნელოვანია
მიკროსერვისი გაყოფილი პასუხისმგებლობით
გარე B2B ინტეგრაციის პლატფორმები
მუშაობა API- ზე რამდენიმე დამოუკიდებელ გუნდზე
კრიტიკული სისტემები, სადაც შეცდომა დაუშვებელია (ფინანსები, საჯარო სერვისები)
ხელშეკრულების ტესტირება არის საიმედო ხიდი სერვერსა და კლიენტს შორის. ჩვენ დაგვეხმარება პროცესის დამყარებაში, რომლის დროსაც რაიმე განახლება არ დაარღვევს ინტეგრაციას და არ მოუტანს მოულოდნელ შეცდომებს.