დაუკავშირდით API– ს კოდის გარეშე: 8 ნაბიჯი

2024 ავტორი: John Day | [email protected]. ბოლოს შეცვლილი: 2024-01-30 10:16

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

თუ შენ გგავს, იღბლიანი ხარ! ჩვენ აქ ვართ იმის ახსნა, თუ როგორ უნდა ვიმუშაოთ API– ებთან, როგორ წავიკითხოთ API დოკუმენტები და როგორ რეალურად გამოვიყენოთ API– დან დაბრუნებული მონაცემები.

ჩვენ მოვიყვანეთ მეგობარი, რათა მგზავრობა გაცილებით გაადვილდეს.

გაიცანი სლეში

სლეში არის მიშელის საყვარელი, საყვარელი ძაღლი (სურათები ზემოთ). მიშელი არის პროგრამული უზრუნველყოფის ინჟინერი, რომელიც აშენებს API– ებს. მიშელი ნამდვილად სარგებლობს თავისი სამსახურით და შთაგონება მიიღო სამუშაოების შექმნის API– ებიდან Slash– ის ტრენინგში.

როგორც მოგეხსენებათ, API არის ბრძანებების კრებული, რომელიც მომხმარებელს შეუძლია მისცეს ვებ სერვისს, პასუხების ნაკრებთან ერთად, რომელიც შეესაბამება მოთხოვნას. მიშელმა ასწავლა სლეშს ზუსტად იგივეს გაკეთება. სლეში კარგი ბიჭია, იცის სხვადასხვა სახის ბრძანებები და ყოველთვის სწორად პასუხობს მანამ, სანამ თქვენ მისცემთ თხოვნას, რომელსაც ასწავლიან. როდესაც ის ზედმეტად აღელვებს, კუდი გიჟდება - ეს არ არის ის, რაც მიშელმა ასწავლა მას API– ებთან დაკავშირებით, ეს მხოლოდ იმიტომ, რომ ის საყვარელი ლეკვია და ნამდვილად სიამოვნებს მისი ვარჯიში!

ნაბიჯი 1: გადაწყვიტეთ რა API გჭირდებათ

რა ინფორმაციას ეძებთ ან გსურთ შეცვალოთ?

ცდილობთ დაიჭიროთ @dougthepug– ის ყველა Instagram პოსტი? იქნებ გინდათ ავტომატურად დარეკოთ ყველას, ვინც მიყვება თქვენი ძაღლის ტვიტერს (რადგანაც მიუხედავად იმისა, რომ ძაღლებს არ შეუძლიათ ლაპარაკი, მათ ბევრი აქვთ სათქმელი, ჩვენ ვიცით, რომ სლეშს ნამდვილად აქვს).

თუ თქვენ უკვე იცით საიტი ან API, რომელთანაც დაკავშირებას ცდილობთ, გადადით პირდაპირ ნაბიჯი 2. თუ თქვენ ცდილობთ მონაცემების მოძიებას, მაგრამ არ იცით საიდან დაიწყოთ, Google არის თქვენი მეგობარი. მოძებნეთ "[პერსონალი, რომელიც გაინტერესებთ] API" და ნახეთ რა გამოვა. ალბათ გაგიკვირდებათ, რამდენი ინფორმაცია არსებობს.

თუ გსურთ API– ს მარტივი მაგალითი, შეგიძლიათ გამოიყენოთ ის მიშელი, რომელიც დამზადებულია სლეშის ვარჯიშის დროს. მას აქვს რამდენიმე მისი საყვარელი ბრძანება, როგორიცაა ბურთების მოპოვება და ხვრელების თხრა. ჩვენ გამოვიყენებთ მას ჩვენს დანარჩენ მაგალითებში.

ნაბიჯი 2: იპოვნეთ API დოკუმენტები

ცნობილი კომპანიების მიერ მოწოდებულ API– ს უნდა ჰქონდეს საფუძვლიანი დოკუმენტაცია მათი გამოყენების შესახებ.

ამის საპოვნელად google "[Insert Company] API დოკუმენტაცია" ან "[Insert Company] დეველოპერი".

შედეგებმა უნდა მიგიყვანოთ დეველოპერის პორტალზე. მოძებნეთ ბმული, სადაც ნათქვამია "Docs", "Documentation", "Reference" or "Technical Reference".

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

თუ API, რომელთანაც გსურთ დაკავშირება, არ არის ცნობილი (Slash– ის მსგავსად), შეიძლება დაგჭირდეთ დეველოპერისთვის დოკუმენტაციის მოთხოვნა. მათ შეიძლება ჰქონდეთ PDF, რომელიც შეიცავს თქვენთვის საჭირო ინფორმაციას ან ონლაინ დოკუმენტაციას, რომელიც არ არის ჩამოთვლილი მათ ვებგვერდზე.

თუ თქვენ გამოტოვეთ ბმული წინა საფეხურზე, Slash– ის API დოკუმენტები შეგიძლიათ იხილოთ აქ.

ნაბიჯი 3: იპოვნეთ საბოლოო წერტილი

API დოკუმენტები შეიძლება შემაძრწუნებლად გამოიყურებოდეს, მაგრამ მას შემდეგ რაც იცით რა უნდა მოძებნოთ, ისინი ჩვეულებრივ კარგად არის სტრუქტურირებული და საკმაოდ სტანდარტიზებული.

პირველი რაც უნდა ვეძებოთ არის შესაბამისი საბოლოო წერტილი (ები). უნდა არსებობდეს ერთი საბოლოო წერტილი, რომელიც შეესაბამება თითოეული ტიპის მონაცემს. საბოლოო წერტილი შეიძლება ასე გამოიყურებოდეს:

slashtheapidog.com/api/bones/{id}

ან უბრალოდ

/ძვლები

დოკუმენტაციას უნდა ჰქონდეს ბოლო წერტილების სია. ისინი შეიძლება იყოს უმაღლესი დონის დოკუმენტებში ან განყოფილების ქვეშ, სახელწოდებით "მითითება", "საბოლოო წერტილები" ან "მეთოდები". სწორი საბოლოო წერტილის მოსაძებნად, მოძებნეთ სახელი, რომელიც შეესაბამება მონაცემებს, რომელსაც თქვენ ეძებთ. მაგალითად, თუ გსურთ ყველა ხვრელის სია, რომელიც სლეშმა გათხრა, /ხვრელები ალბათ სწორია. ნებისმიერ შემთხვევაში, თითოეულ საბოლოო წერტილს უნდა ჰქონდეს აღწერა, რომელიც დაეხმარება ახსნას რას აკეთებს.

მისი დოკუმენტებიდან, ეს არის Slash– ის API– ის ბოლო წერტილები, რომლებიც დაკავშირებულია ხვრელებთან:

მიიღეთ

მიიღეთ

განათავსეთ

განათავსეთ

გამოქვეყნება

ნაბიჯი 4: განსაზღვრეთ თქვენი მოთხოვნის ტიპი

ახლა, როდესაც თქვენ იპოვნეთ სწორი საბოლოო წერტილი, თქვენ უნდა განსაზღვროთ მოთხოვნის ტიპი მისი გაგზავნისთვის.

არსებობს 4 განსხვავებული ტიპის მოთხოვნა:

მიიღეთ

GET მოთხოვნა არის ის, თუ როგორ სთხოვთ API– ს უპასუხოს იმას, რაც მას აქვს, ყველაზე ხშირად მონაცემებს. თქვენ შეგიძლიათ მოითხოვოთ კონკრეტული ინფორმაცია ერთი ერთეულის ან ერთეულების ჯგუფის შესახებ საბოლოო წერტილისა და პარამეტრების საფუძველზე. ეს უდრის სლეშს სთხოვოს მოგიტანოს მისი ერთი ძვალი ან მთელი მისი ძვალი.

პოსტი

POST მოთხოვნა არის ის, თუ როგორ ეუბნებით API– ს შექმნას რაიმე ახალი. ეს იგივეა, რაც სლეშს სთხოვოს გათხაროს (შექმნას) თქვენთვის ახალი ხვრელი.

ᲓᲐᲓᲔᲑᲐ

PUT მოთხოვნა არის ის, თუ როგორ ეუბნებით API- ს განახლება რაღაც, რაც ადრე შეიქმნა. ეს იგივეა, რაც სლეშს სთხოვოს უფრო ღრმად (განახლება) მის გათხრილ ხვრელში.

წაშლა

წაშლა მოთხოვნა არის ის, თუ როგორ ეუბნებით API- ს წაშალოს ის, რაც ადრე შეიქმნა. ეს იგივეა, რაც სლეშს სთხოვოს დაფაროს (წაშალოს) მანამდე გათხრილი ხვრელი.

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

ნაბიჯი 5: გაიგეთ პარამეტრები

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

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

Slash– ის API პარამეტრები შეიძლება ასე გამოიყურებოდეს ბურთების მოსაპოვებლად:

მიიღეთ

ნაბიჯი 6: თქვენი მოთხოვნის ფორმატირება

ჩვენ გვაქვს ყველა საჭირო ინფორმაცია, ახლა ჩვენ უბრალოდ უნდა გავაკეთოთ მოთხოვნა!

აქ მოცემულია API– სთან დაკავშირების ორი განსხვავებული გზა, რომელსაც კოდი არ სჭირდება. მოდით დავუკავშირდეთ Slash– ის API– ს, რომ მივიღოთ მისი ბურთების სია GET თხოვნით

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

Parabola არის ვებ აპლიკაცია, რომელიც საშუალებას გაძლევთ მარტივად დაუკავშიროთ API– ებს და შემდეგ ვიმუშაოთ მონაცემებთან ვიზუალური, გადასაადგილებელი ინსტრუმენტის საშუალებით.