API -ге кодсыз қосылыңыз: 8 қадам

2024 Автор: John Day | [email protected]. Соңғы өзгертілген: 2024-01-30 10:23

Бұл нұсқаулық API қолдануды қажет ететін, бірақ қалай бастау керектігін білмейтін адамдарға арналған. Сіз API -мен жұмыс істеудің неге пайдалы екенін білесіз және бұл нұсқаулық сізге мұны қалай жасау керектігін көрсетеді.

Егер бұл сізге ұқсаса, сіз сәттілікке жетесіз! Біз API -мен қалай жұмыс істеу керектігін, API құжаттарын қалай оқу керектігін және API -ден қайтып келетін деректерді қалай пайдалану керектігін түсіндіру үшін келдік.

Біз жолды жеңілдету үшін досымызды алып келдік.

Слэшпен танысыңыз

Слэш - бұл Мишельдің сүйкімді, сүйкімді иті (жоғарыдағы суретте). Мишель - API құратын бағдарламалық қамтамасыз ету инженері. Мишель өзінің жұмысынан шынымен ләззат алады және Slash тренингінде өзінің API құрудағы жұмысынан шабыт алады.

Өздеріңіз білетіндей, API - бұл сұранысты қанағаттандыратын жауаптар жиынтығымен бірге қолданушы веб -қызметке бере алатын командалар жинағы. Мишель Slash -ті дәл осылай жасауға үйретті. Слэш - жақсы бала, әр түрлі командаларды біледі және сіз оған үйретілген сұранысты бергенде әрқашан дұрыс жауап береді. Ол қатты толқып кеткенде, оның құйрығы есінен танып қалады - бұл Мишельдің оған API -мен байланысты үйреткені емес, себебі ол сүйкімді күшік болғандықтан және оның жаттығуын шынымен ұнатады!

1 -қадам: Сізге қандай API қажет екенін шешіңіз

Сіз қандай ақпаратты іздейсіз немесе өзгерткіңіз келеді?

Сіз @dougthepug -ның Инстаграмдағы барлық жазбаларын алуға тырысасыз ба? Мүмкін сіз өзіңіздің итіңіздің твиттеріне жазылғандардың барлығына автоматты түрде твит жазғыңыз келеді (өйткені иттер сөйлей алмаса да, олар көп нәрсені айтады, біз білеміз, Slash сенімді).

Егер сіз қосылғыңыз келетін сайтты немесе API -ді білсеңіз, 2 -қадамға өтіңіз. Егер сіз деректерді табуға тырыссаңыз, бірақ қайдан бастау керектігін білмесеңіз, Google сіздің досыңыз. «[Сізді қызықтыратын] API» деп іздеңіз және не болатынын көріңіз. Сіз бұл жерде қанша ақпарат бар екеніне таң қалуыңыз мүмкін.

Егер сізге қарапайым API үлгісі қажет болса, сіз Slash жаттығуы кезінде жасалған Мишельді пайдалана аласыз. Доптарды алу және шұңқырларды қазу сияқты оның сүйікті командалары бар. Біз оны қалған мысалдарда қолданатын боламыз.

2 -қадам: API құжаттарын табыңыз

Белгілі компаниялар ұсынған API-лерде оларды пайдалану туралы толық құжаттамасы болуы керек.

Оларды табу үшін google «[Insert Company] API құжаттамасы» немесе «[Insert Company] әзірлеуші».

Нәтижелер сізді әзірлеуші порталына апаруы керек. «Құжаттар», «Құжаттар», «Анықтама» немесе «Техникалық анықтама» деп жазылған сілтемені іздеңіз.

Құжаттарда сізге қажет нақты API іздеу қажет болуы мүмкін, себебі кейде көптеген опциялар болуы мүмкін. Мысалы, Facebook -те маркетингке, жарнамаларға, беттерге және басқаларға арналған бөлек API бар.

Егер сіз қосылғыңыз келетін API жақсы белгілі болмаса (мысалы, Slash сияқты), әзірлеушіден құжаттарды сұрау қажет болуы мүмкін. Олар сізге қажет ақпаратты немесе олардың веб -сайтында жоқ онлайн құжаттаманы қамтитын PDF болуы мүмкін.

Егер сіз алдыңғы қадамда сілтемені жіберіп алсаңыз, Slash API құжаттарын мына жерден табуға болады.

3 -қадам: Соңғы нүктені табыңыз

API құжаттары қиын болып көрінуі мүмкін, бірақ сіз не іздеу керектігін білсеңіз, олар әдетте жақсы құрылымдалған және өте стандартталған.

Іздеу керек бірінші нәрсе - тиісті соңғы нүкте. Қажетті деректердің әр түріне сәйкес келетін бір соңғы нүкте болуы керек. Соңғы нүкте келесідей болуы мүмкін:

slashtheapidog.com/api/bones/{id}

немесе жай

/сүйектер

Құжаттамада соңғы нүктелердің тізімі болуы керек. Олар жоғары деңгейдегі құжаттарда немесе «сілтеме», «соңғы нүктелер» немесе «әдістер» деп аталатын бөлімнің астында болуы мүмкін. Дұрыс соңғы нүктені табу үшін сіз іздеген деректерге сәйкес келетін атауды іздеңіз. Мысалы, егер сіз Slash қазған барлық тесіктердің тізімін алғыңыз келсе, /тесіктер дұрыс болуы мүмкін. Қалай болғанда да, әрбір соңғы нүктеде не істейтінін түсіндіруге көмектесетін сипаттамасы болуы керек.

Оның құжаттарынан бұл Slash API -де тесіктерге қатысты соңғы нүктелер:

Https://slashtheapidog.com/api/holes алыңыз

Https://slashtheapidog.com/api/holes/{id} алу

Https://slashtheapidog.com/api/holes жариялау

Https://slashtheapidog.com/api/holes/{id} қойыңыз

ЖАЗУ

4 -қадам: Сіздің сұраныс түрін анықтаңыз

Енді сіз дұрыс соңғы нүктені таптыңыз, оны жіберу үшін сұрау түрін анықтауыңыз керек.

Өтініштердің 4 түрі бар:

АЛУ

GET сұранысы - бұл API -ден оның мәліметтеріне жауап беруін сұрау әдісі. Сіз соңғы нүкте мен параметрлерге негізделген бір элемент немесе элементтер тобы туралы нақты ақпаратты сұрай аласыз. Бұл Slash -тен сізге оның сүйектерінің біреуін немесе барлық сүйектерін әкелуді сұрауға тең.

ПОСТ

POST сұранысы - бұл API -ге жаңа нәрсе жасауды қалай айтқаныңыз. Бұл Slash -тен сіз үшін жаңа шұңқыр қазуды (жасауды) сұрауға ұқсас.

ҚОСУ

PUT сұрауы - бұл API -ге бұрын жасалған нәрсені жаңартуға қалай айтуға болатыны. Бұл Slash -тен ол қазған шұңқырға тереңірек қазуды (жаңартуды) сұрауға ұқсас.

ЖОЮ

DELETE сұранысы - бұл API -ге бұрын жасалған нәрсені жоюды қалай айтуға болатыны. Бұл Slash -тен бұрын қазған шұңқырды жабуды (жоюды) сұрауға ұқсас.

Осы төрт түр туралы ойланыңыз. Сіз ақпарат аласыз ба, жаңа жазба жасайсыз ба, бар жазбаны өзгертесіз бе немесе өшіресіз бе? Бұл жауап сізге қандай сұраныс түрін қажет ететінін дәл көрсетеді.

5 -қадам: Параметрлерді түсіну

Көптеген сұраулар қосымша параметрлерді қажет етеді. Параметрлер - бұл сіздің сұрауыңыздың мәліметтері. Мысалы, егер сіз Slash сізге қызыл шарларды әкелгенін қаласаңыз, түсін көрсетуіңіз керек. Егер сіз оның жаңа шұңқыр жасауын қаласаңыз, оны қайда қою керектігін және қаншалықты терең қазу керектігін айтуыңыз керек.

Сіз сілтеме жасап отырған API құжаттамасында әрбір соңғы нүкте мен сұраныс түрі үшін «Параметрлер» немесе «Опциялар» деп аталатын бөлім болуы керек. Қандай параметрлер қажет екеніне назар аударыңыз, себебі кейбіреулері міндетті емес. Егер параметр міндетті емес деп белгіленсе, құжаттар әдепкі болып табылатын мысалды ұсына алады.

Slash API параметрлері шарларды алу үшін келесідей болуы мүмкін:

Https://slashtheapidog.com/api/balls алыңыз

6 -қадам: Сіздің сұранысты пішімдеңіз

Бізде барлық қажетті ақпарат бар, енді біз тек сұраныс беруіміз керек!

Мұнда кодты қажет етпейтін API -ге қосылудың екі түрлі әдісі бар. Https://slashtheapidog.com/api/balls мекен -жайына GET сұрау салу арқылы оның шарлар тізімін алу үшін Slash API -ге қосылайық.

Парабола - егер сіз кодсыз мәліметтерге қосылғыңыз келсе және олармен жұмыс жасағыңыз келсе

Parabola-бұл API-ге оңай қосылуға, содан кейін визуалды, апарып тастау құралы арқылы деректермен жұмыс жасауға мүмкіндік беретін веб-бағдарлама.