Свържете се с API без код: 8 стъпки

2024 Автор: John Day | [email protected]. Последно модифициран: 2024-01-30 07:50

Това ръководство е предназначено за хора, които имат нещо, което искат да постигнат, което изисква използване на API, но не са съвсем сигурни как да започнат. Вече знаете защо работата с API е полезна и това ръководство ще ви покаже как да направите това.

Ако това звучи като вас, имате късмет! Тук сме, за да обясним как да работим с API, как да четем API документи и как всъщност да използваме данните, връщащи се от API.

Доведохме приятел, за да направим пътуването много по -лесно.

Запознайте се с Slash

Slash е очарователното, мило куче на Мишел (на снимката по -горе). Мишел е софтуерен инженер, който изгражда API. Мишел наистина се радва на работата си и се е вдъхновила от работата си, изграждайки API в обучението на Slash.

Както може би знаете, API е колекция от команди, които потребителят може да даде на уеб услуга, заедно с набор от отговори, които съответстват на заявката. Мишел е обучила Слаш да прави точно същото. Slash е добро момче, знае разнообразни команди и винаги реагира правилно, стига да му дадете молба, на която е научен. Когато се развълнува допълнително, опашката му полудява - това не е нещо, което Мишел го е научила, свързано с API, просто защото е мило кученце и наистина се радва на обучението си!

Стъпка 1: Решете какъв API имате нужда

Каква информация търсите или искате да промените?

Опитвате ли се да вземете всички публикации в Instagram на @dougthepug? Може би искате да туитвате автоматично всеки, който следва туитъра на вашето куче (защото въпреки че кучетата не могат да говорят, те имат да кажат много, знаем, че Slash със сигурност го прави).

Ако вече познавате сайта или API, към които се опитвате да се свържете, преминете директно към Стъпка 2. Ако се опитвате да намерите данни, но не сте сигурни откъде да започнете, Google е ваш приятел. Потърсете „[неща, от които се интересувате] API” и вижте какво се появява. Може да се изненадате колко информация има там.

Ако искате прост примерен API, можете да използвате този, направен от Мишел, докато тренирате Slash. Той има някои от любимите му команди като извличане на топки и копаене на дупки. Ще го използваме в останалите примери.

Стъпка 2: Намерете API документите

API, предоставени от известни компании, трябва да имат подробна документация за това как да ги използвате.

За да ги намерите, потърсете в google „[Insert Company] API документация“или „[Insert Company] разработчик“.

Резултатите трябва да ви отведат до портала за програмисти. Потърсете връзка, която гласи „Документи“, „Документация“, „Справка“или „Техническа справка“.

В рамките на документите може да се наложи да потърсите конкретния API, който искате, тъй като понякога може да има много опции. Facebook например има отделни API за маркетинг, реклами, страници и др.

Ако API, към който искате да се свържете, не е добре познат (като Slash), може да се наложи да поискате документация от разработчика. Те могат да имат PDF, съдържащ необходимата ви информация, или онлайн документация, която не е посочена на уебсайта им.

Ако сте пропуснали връзката в предишната стъпка, документите за API на Slash могат да бъдат намерени тук.

Стъпка 3: Намерете крайната точка

Документите за API могат да изглеждат обезсърчаващи, но след като знаете какво да търсите, те обикновено са добре структурирани и доста стандартизирани.

Първото нещо, което трябва да се търси, е подходящата крайна точка (и). Трябва да има една крайна точка, съответстваща на всеки тип данни, които искате. Крайната точка може да изглежда така:

slashtheapidog.com/api/bones/{id}

или просто

/кости

Документацията трябва да има списък с крайни точки. Те могат да бъдат на най -високо ниво в документите или под раздел, наречен „справка“, „крайни точки“или „методи“. За да намерите правилната крайна точка, потърсете името, което съответства на данните, които търсите. Например, ако искате списък с всички дупки, които Slash е изкопал, /дупките вероятно са правилните. Във всеки случай всяка крайна точка трябва да има описание, което да обясни какво прави.

От неговите документи това са крайните точки в API на Slash, свързани с дупки:

ВЗЕМЕТЕ

ВЗЕМЕТЕ

POST

ПОСТАВЕТЕ

POST

Стъпка 4: Определете типа на вашата заявка

Сега, когато сте намерили правилната крайна точка, трябва да определите типа заявка, която да я изпратите.

Има 4 различни типа заявки:

ПОЛУЧАВАЙТЕ

Искането за GET е начинът, по който искате от API да отговори с нещо, което има, най -често с данни. Можете да поискате конкретна информация за един елемент или група елементи въз основа на крайната точка и параметрите. Това е равносилно на това да помолите Слаш да ви донесе една от костите му или всичките му кости.

POST

POST заявка е начинът, по който кажете на API да създаде нещо ново. Това е подобно на това да помолите Slash да изкопае (създаде) нова дупка за вас.

СЛАГАМ

Искането за PUT е начинът, по който казвате на API да актуализира нещо, което е било създадено преди това. Това е подобно на искането на Slash да копае по -дълбоко (актуализира) в дупката, която е изкопал.

ИЗТРИЙ

ИЗТРИВАНЕто искане е начинът, по който кажете на API да изтрие нещо, което е било създадено преди това. Това е подобно на искането на Slash да прикрие (изтрие) дупка, която преди това е изкопал.

Помислете за тези четири типа. Получавате ли информация, създавате нов запис, променяте съществуващ запис или го изтривате? Този отговор ви казва точно какъв тип заявка се нуждаете.

Стъпка 5: Разберете параметрите

Много заявки изискват допълнителни параметри. Параметрите са подробности за вашата заявка. Например, ако искате Slash да ви донесе всички топки, които са червени, трябва да посочите цвета. Ако искате той да създаде нова дупка, трябва да му кажете къде да я постави и колко дълбоко да копае.

Документацията за API, към която се позовавате, трябва да има раздел, наречен "Параметри" или "Опции" за всяка крайна точка и тип заявка. Обърнете внимание кои параметри са необходими, тъй като някои са незадължителни. Ако параметър е маркиран като незадължителен, документите могат да предоставят пример, който също е по подразбиране.

Параметрите на API на Slash може да изглеждат по следния начин за извличане на топки:

ВЗЕМЕТЕ

Стъпка 6: Форматирайте заявката си

Имаме цялата необходима информация, сега трябва само да направим заявката!

Ето два различни начина за свързване с API, които не изискват код. Нека се свържем с API на Slash, за да получим неговия списък с топки, като направим GET заявка на

Parabola - ако искате да се свържете и да работите с данни без код

Parabola е уеб приложение, което ви позволява лесно да се свързвате с API и след това да работите с данните чрез визуален инструмент за плъзгане и пускане.