იმისათვის, რომ API ადვილად გააცნობიეროს, განახორციელოს და მხარი დაუჭიროს, მნიშვნელოვანია ხარისხის დოკუმენტაცია. ჩვენ ვაწყობთ დოკუმენტაციის ავტომატურ წარმოებას OpenAPI სპეციფიკაციებზე დაყრდნობით Swagger UI და Redoc- ის გამოყენებით - API ვიზუალიზაციის ორი ყველაზე პოპულარული ინსტრუმენტი.
ეს საშუალებას აძლევს დეველოპერებს უზრუნველყონ ინტერაქტიული ინტერფეისი, სადაც შეგიძლიათ შეისწავლოთ მეთოდების სტრუქტურა, შეამოწმოთ მოთხოვნები და სწრაფად დაუკავშირდეთ თქვენს API- ს.
რა შედის დოკუმენტაციაში
| განყოფილება | აღწერა |
|---|---|
| Endpoint 'y და მეთოდები | მარშრუტების სრული სია, HTTP მეთოდები, პარამეტრები, სათაურები |
| შეკითხვის/პასუხების მაგალითები | სკრიპტები curl, Postman, JavaScript, Python და სხვა ენებისთვის |
| ავტორიზაცია | მხარდაჭერა JWT, OAuth2, API Key პირდაპირ ინტერფეისიდან |
| ობიექტების სქემები | მოდელების, ინვერსიული სტრუქტურების და მონაცემების მოთხოვნების აღწერა |
| შეცდომის კოდი | ყველა შესაძლო ახსნა |
ხელსაწყოები, რომლებსაც ჩვენ ვიყენებთ
Swagger UI - ინტერაქტიული დოკუმენტაცია ბრაუზერში, ტესტირების შესაძლებლობით
Redoc არის კითხვის, სტატიკური ინტერფეისი, რომელიც იდეალურია საიტზე გამოქვეყნებისთვის
OpenAPI 3. 0/3. 1 - სპეციფიკაციის ფორმატი, რომლის საფუძველზეც ყველაფერი შენდება
კოდის ავტომატური გამომუშავება - დოკუმენტაცია, აღწერილობა, ვერსიები და განახლებები ავტომატურად
ექსპორტი JSON/YAML/HTML
უპირატესობები გუნდისა და პარტნიორებისთვის
ახალი დეველოპერების დაჩქარება
ინტეგრაციის შეცდომების რაოდენობის შემცირება
ყოველთვის აქტუალური, სინქრონიზებული დოკუმენტაციის კოდით
ინტეგრაციის სწრაფი დაწყება ტექნიკური დახმარების გარეშე
საჯარო ან კერძო პორტალებზე დოკუმენტაციის გამოქვეყნების მარტივია
სადაც განსაკუთრებით მნიშვნელოვანია
ღია API გარე დეველოპერებისთვის
შიდა API აქტიური განვითარებით
პლატფორმები B2B ინტეგრაციებით და SDK
სერვისები, რომლებიც მოითხოვენ წესებს და სქემების შესაბამისობას
Swagger და Redoc არის ახალი თაობის API დოკუმენტაციის სტანდარტი. ჩვენ ველოდებით დოკუმენტაციის წარმოქმნას, განახლებას და გამოქვეყნებას ისე, რომ ნებისმიერ დეველოპერს შეუძლია დაიწყოს ინტეგრაცია თქვენი API- დან რამდენიმე წუთში.