როდესაც API აქტიურად ვითარდება, მნიშვნელოვანია შეინარჩუნოს თავსებადობა ვერსიებს შორის და თავიდან აიცილოს სიტუაციები, როდესაც ერთი ცვლილება არღვევს ათობით კლიენტის ინტეგრაციას. ჩვენ ვასრულებთ კონტრაქტების სრულ ვერსიას, რაც საშუალებას გაძლევთ გააკონტროლოთ ცვლილებები და შეუფერხებლად განაახლოთ API მომხმარებლებისთვის რისკის გარეშე.
ეს კრიტიკულად მნიშვნელოვანია მიკრო სერვისის არქიტექტურაში, B2B ინტეგრაციასა და ღია API პროდუქტებში, სადაც სხვადასხვა მომხმარებელი იყენებს ინტერფეისის სხვადასხვა ვერსიას.
რა ვერსიები გვაქვს
| ობიექტი | აღწერა |
|---|---|
| OpenAPI სპეცი | ჩვენ ვიცავთ დოკუმენტაციისა და ხელშეკრულების თითოეულ ვერსიას |
| Endpoint'ы | დაამატეთ ვერსიები URL- ში ('/v1/', '/v2/'), შეინარჩუნეთ backward კომპოზიცია |
| კონტრაქტები (Pact, Dredd) | კლიენტსა და სერვერს შორის ურთიერთქმედების პირობების დაფიქსირება |
| მონაცემთა მოდელები | მოთხოვნის სტრუქტურაში ცვლილებების კონტროლი და პასუხი |
როგორ ვრეაგირებთ
API- ს რამდენიმე ვერსიის მხარდაჭერა პარალელურად- ვერსიის მკაფიო მითითება URL- ში, სათაურებში ან პარამეტრებში
- კონტრაქტების თითოეული ვერსიის ავტომატიზაცია (Pact, Postman, Jest, Dredd)
- სპეციფიკაციების ვერსია Git- ში ან CI/CD- ის საშუალებით
- თითოეული ცვლილებით მომხმარებლებისთვის დოკუმენტაცია და ჩანგელოგი
უპირატესობები
გარანტირებული ინტეგრაციის სტაბილურობა- ახალი ფიჩების გაცემის შესაძლებლობა მომხმარებლების „დაშლის“ რისკის გარეშე
- ვერსიებს შორის მიგრაციის გამარტივება
- ცვლილებების ნათელი ისტორია და კონტრაქტების კონტროლი
- გამჭვირვალეობა გარე და შიდა განვითარების ბრძანებებისთვის
სადაც განსაკუთრებით მნიშვნელოვანია
მიკროსერვისის არქიტექტურა მრავალი დამოკიდებულებით- პლატფორმები საჯარო ან B2B API
- გრძელვადიანი ხელშეკრულებებით ფინანსური და გადახდის სისტემები
- მობილური პროგრამები დამოკიდებულია სტაბილურ API ინტერფეისზე
კონტრაქტების ვერსია არის პროგნოზირებისა და ნდობის საფუძველი API- ში. ჩვენ წარმოგიდგენთ პროცესებს, რომლებიც საშუალებას გაძლევთ შეცვალოთ და განავითაროთ API ტკივილის გარეშე, შეინარჩუნოთ თავსებადობა და გამჭვირვალობა ყველა მხარისთვის.
პოპულარული თემები
ძირითადი თემები
დაგვიკავშირდით
შეავსეთ ქვემოთ მოცემული ფორმა და ჩვენ გიპასუხებთ უახლოეს დროში.