Versioning API: `/v1/`, `Accept: version`, `GraphQL alias`

როდესაც API ვითარდება, ჩნდება ახალი მეთოდები, პარამეტრები და ლოგიკა. იმისათვის, რომ არ დაირღვეს ამჟამინდელი მომხმარებლების მუშაობა, გამოიყენება API ვერსია. ჩვენ მხარს ვუჭერთ ვერსიის რამდენიმე მიდგომას, რაც ინტეგრატორებს საშუალებას აძლევს გამოიყენონ ინტერფეისის სწორი ვერსია სტაბილური მუშაობის რისკის გარეშე.

ეს მნიშვნელოვანია როგორც პლატფორმის შედგენისას, ასევე ძველი მომხმარებლების განახლებების, ტესტირების ან შენარჩუნების დროს.


ვერსირების მეთოდები

მეთოდიაღწერა და უპირატესობები
ვერსია URL- ში ('/v1/')ყველაზე გასაგები და პოპულარული გზა მოსახერხებელია REST API- სთვის
სათაური Acceptმაგალითი: 'Accept: აპლიკაცია/vnd. api+json; version = 2 '- მონაცემებს გამოყოფს ვერსიიდან
GraphQL alias / versioned fieldsსხვადასხვა ვერსიები ალიასის საშუალებით: 'userV1', 'userV2' - მოსახერხებელია თანდათანობით მიგრაციისთვის
ვერსიები სქემის დონეზეთითოეული ვერსიისთვის OpenAPI/Swagger- ის ცალკეული სქემები და მოდულები

როგორ ხორციელდება

API სტრუქტურა '/v1/', '/v2/' და დამოუკიდებელი მარშრუტები

სათაურების შემოწმება 'Accept' და 'X-API-ვერსია'
  • GraphQL მხარს უჭერს ალიასს და ვერსირებულ სქემებს ('userV1', 'userV2')
  • ახალი ვერსიების A/B ტესტირების შესაძლებლობა წარმოების რისკის გარეშე
  • ანალიზისა და მიგრაციისთვის თითოეული ვერსიის მიმართვის ლოგიკა

უპირატესობები ბიზნესისა და ინტეგრატორებისთვის

ძველი მომხმარებლების მხარდაჭერა შენელების გარეშე
  • API- ს რამდენიმე თაობის პარალელური მუშაობა
  • ახალი ფუნქციების უსაფრთხო დანერგვა საპირისპირო თავსებადობის გარეშე
  • ინფრასტრუქტურის მასშტაბისა და განახლების მოქნილობა
  • გამჭვირვალე მიგრაცია კონტროლსა და ანალიზს შორის

სადაც განსაკუთრებით მნიშვნელოვანია

პლატფორმები მრავალი გარე კლიენტთან
  • პროექტები API-first მიდგომით და გრძელი ცხოვრების ციკლი
  • ინტეგრაცია ბანკებთან, პროვაიდერთან, B2B პარტნიორებთან
  • გრძელი მობილური ან IoT კლიენტების სისტემები

API ვერსია არის ინტეგრაციის საიმედოობისა და მოქნილობის საფუძველი. მიუხედავად ფორმატისა (REST, GraphQL ან GRPC), ჩვენ გთავაზობთ ინტერფეისების უსაფრთხო განვითარებას - წარუმატებლობის, კონფლიქტების და თავსებადობის დაკარგვის გარეშე.

დაგვიკავშირდით

შეავსეთ ქვემოთ მოცემული ფორმა და ჩვენ გიპასუხებთ უახლოეს დროში.

ტელეფონი:

+54 911 6827 4738

+357 95 595 767

ელ.ფოსტა:

info@jackcode.io

support@jackcode.io