Միացեք API- ներին առանց կոդի. 8 քայլ

2024 Հեղինակ: John Day | [email protected]. Վերջին փոփոխված: 2024-01-30 09:46

Այս ուղեցույցը նախատեսված է այն մարդկանց համար, ովքեր ունեն ինչ -որ բան, որին ցանկանում են հասնել, ինչը պահանջում է API- ի օգտագործում, բայց վստահ չեն, թե ինչպես սկսել: Դուք արդեն գիտեք, թե ինչու է API- ով աշխատել կարողանալը օգտակար, և այս ուղեցույցը ցույց կտա ձեզ, թե ինչպես դա անել:

Եթե դա հնչում է ձեզ նման, ապա հաջողակ եք: Մենք այստեղ ենք բացատրելու, թե ինչպես աշխատել API- ների հետ, ինչպես կարդալ API- ի փաստաթղթերը և ինչպես իրականում օգտագործել API- ից ստացվող տվյալները:

Մենք ընկեր ենք բերել ճանապարհը շատ ավելի հեշտացնելու համար:

Հանդիպեք Սլեշին

Սլեշը Միշելի հիասքանչ, սիրելի շունն է (նկարը ՝ վերևում): Միշելը ծրագրային ապահովման ինժեներ է, որը կառուցում է API- ներ: Միշելը իսկապես վայելում է իր աշխատանքը և ոգեշնչվել է Slash- ի մարզման իր աշխատանքային API- ներից:

Ինչպես երևի գիտեք, API- ն հրամանների հավաքածու է, որը օգտագործողը կարող է տալ վեբ ծառայությանը ՝ մի շարք պատասխանների հետ, որոնք համապատասխանում են խնդրանքին: Միշելը սովորեցրել է Սլեշին նույնը անել: Սլեշը լավ տղա է, տիրապետում է մի շարք հրամանների և միշտ ճիշտ է պատասխանում, քանի դեռ դուք նրան սովորեցրած խնդրանք եք տալիս: Երբ նա շատ է ոգևորվում, նրա պոչը խելագարվում է. Սա այն չէ, ինչ Միշելը նրան սովորեցրել է API- ների հետ կապված, պարզապես այն պատճառով, որ նա սիրելի ձագ է և իսկապես վայելում է իր մարզումները:

Քայլ 1. Որոշեք, թե ինչ API է ձեզ անհրաժեշտ

Ի՞նչ տեղեկատվություն եք փնտրում կամ ցանկանում եք փոխել:

Փորձու՞մ եք գրավել @dougthepug- ի Instagram- ի բոլոր գրառումները: Միգուցե դուք ցանկանում եք ինքնաբերաբար թվիթ գրել ցանկացած մարդու, ով հետևում է ձեր շան թվիթերին (քանի որ չնայած շները չեն կարողանում խոսել, բայց նրանք շատ բան ունեն ասելու, մենք գիտենք, որ Սլեշը դա անում է):

Եթե դուք արդեն գիտեք այն կայքը կամ API- ն, որին փորձում եք միանալ, անմիջապես անցեք Քայլ 2. Եթե փորձում եք գտնել տվյալներ, բայց վստահ չեք, թե որտեղից սկսել, Google- ը ձեր ընկերն է: Որոնեք «[Ձեզ հետաքրքրող նյութեր] API» և տեսեք, թե ինչ է հայտնվում: Դուք կարող եք զարմանալ, թե որքան տեղեկատվություն կա այնտեղ:

Եթե ցանկանում եք API- ի պարզ օրինակ, կարող եք օգտագործել այն Slash- ը մարզելիս պատրաստած Միշելը: Այն ունի իր որոշ սիրված հրամաններ, ինչպիսիք են գնդակներ առնելը և փոսեր փորելը: Մենք կօգտագործենք այն մեր մնացած օրինակներում:

Քայլ 2: Գտեք API փաստաթղթերը

Հայտնի ընկերությունների կողմից տրամադրված API- ները պետք է ունենան մանրակրկիտ փաստաթղթեր, թե ինչպես օգտագործել դրանք:

Սրանք գտնելու համար google «[Insert Company] API փաստաթղթերը» կամ «[Insert Company] developer»:

Արդյունքները պետք է ձեզ տանեն մշակողի պորտալ: Փնտրեք հղում, որն ասում է «Փաստաթղթեր», «Փաստաթղթեր», «Տեղեկանք» կամ «Տեխնիկական տեղեկանք»:

Փաստաթղթերի շրջանակում գուցե անհրաժեշտ լինի փնտրել ձեր ուզած կոնկրետ API- ն, քանի որ երբեմն շատ տարբերակներ կարող են լինել: Facebook- ն, օրինակ, ունի առանձին API- ներ ՝ շուկայավարման, գովազդերի, էջերի և այլնի համար:

Եթե API- ն, որին ցանկանում եք միանալ, այնքան էլ հայտնի չէ (ինչպես Slash- ը), հնարավոր է ՝ ծրագրավորողից պահանջեք փաստաթղթեր: Նրանք կարող են ունենալ ձեզ անհրաժեշտ տեղեկատվություն պարունակող PDF կամ առցանց փաստաթղթեր, որոնք նշված չեն իրենց կայքում:

Եթե բաց եք թողել նախորդ քայլի հղումը, Slash- ի API փաստաթղթերը կարող եք գտնել այստեղ:

Քայլ 3: Գտեք վերջնակետը

API փաստաթղթերը կարող են սարսափելի թվալ, բայց երբ իմանաք, թե ինչ փնտրել, դրանք սովորաբար լավ կառուցված են և բավականին ստանդարտացված:

Առաջին բանը, որ պետք է փնտրել, համապատասխան վերջնակետն է: Պետք է լինի մեկ վերջնակետ `համապատասխան յուրաքանչյուր տեսակի տվյալների, որոնք ցանկանում եք: Վերջնական կետը կարող է այսպիսին լինել.

slashtheapidog.com/api/bones/{id}

կամ պարզապես

/ոսկորներ

Փաստաթղթերը պետք է ունենան վերջնակետերի ցանկ: Նրանք կարող են լինել բարձր մակարդակի փաստաթղթերում կամ «հղում», «վերջնակետեր» կամ «մեթոդներ» կոչվող բաժնի ներքո: Endիշտ վերջնակետը գտնելու համար փնտրեք այն անունը, որը համապատասխանում է ձեր փնտրած տվյալներին: Օրինակ, եթե ցանկանում եք Slash- ի փորած բոլոր անցքերի ցանկը, /անցքերը, հավանաբար, ճիշտն են: Ամեն դեպքում, յուրաքանչյուր վերջնակետ պետք է ունենա նկարագրություն, որը կօգնի բացատրել, թե ինչ է դա անում:

Նրա փաստաթղթերից ՝ Սլեշի API- ի վերջնական կետերն են ՝ կապված անցքերի հետ.

ՇՏԱՊԵՔ

ՇՏԱՊԵՔ

ՓՈՍՏ

Տեղադրեք

ՓՈՍՏ

Քայլ 4: Որոշեք ձեր հայցի տեսակը

Այժմ, երբ գտել եք ճիշտ վերջնակետը, պետք է որոշեք այն ուղարկելու խնդրանքի տեսակը:

Գոյություն ունեն 4 տարբեր տեսակի դիմումներ.

ՍՏԱՆԱԼ

GET- ի հարցն այն է, թե ինչպես եք API- ին խնդրում պատասխանել ինչ -որ բանով, որն ունի, առավել հաճախ ՝ տվյալներով: Դուք կարող եք կոնկրետ տեղեկատվություն պահանջել մեկ կետի կամ իրերի խմբի վերաբերյալ `ելնելով վերջնակետից և պարամետրերից: Սա համարժեք է Սլեշին խնդրել ձեզ բերել իր ոսկորներից մեկը կամ նրա ամբողջ ոսկորը:

ՓՈՍՏ

POST- ի հարցումն այն է, թե ինչպես եք API- ին ասում նոր բան ստեղծելու մասին: Սա նման է այն բանին, որ խնդրեք Սլեշին փորել (ստեղծել) ձեզ համար նոր փոս:

ԴՆԵԼ

PUT- ի հարցն այն է, թե ինչպես եք ասում API- ին ՝ թարմացնել նախկինում ստեղծված ինչ -որ բան: Սա նման է նրան, ինչ Սլեշին խնդրել է ավելի խորը (թարմացնել) իր փորած փոսը:

DEՆTEԵԼ

DEՆLEԵԼ հարցումն այն է, թե ինչպես եք ասում API- ին ջնջել նախկինում ստեղծված մի բան: Սա նման է նրան, որ խնդրեք Սլեշին ծածկել (ջնջել) իր նախկինում փորած փոսը:

Մտածեք այս չորս տեսակների մասին: Տեղեկատվություն եք ստանում, նոր գրառում ստեղծու՞մ, եղած գրությունը փոխու՞մ, թե՞ ջնջել: Այդ պատասխանը ձեզ ճշգրիտ ասում է, թե ինչ տեսակի հարցման կարիք ունեք:

Քայլ 5: Հասկացեք պարամետրերը

Շատ հարցումներ պահանջում են լրացուցիչ պարամետրեր: Պարամետրերը ձեր հարցման մանրամասներն են: Օրինակ, եթե ցանկանում եք, որ Slash- ը ձեզ բերի կարմիր բոլոր գնդակները, ապա պետք է նշեք գույնը: Եթե ցանկանում եք, որ նա նոր փոս ստեղծի, ապա պետք է նրան ասեք, թե որտեղ դնի այն և որքան խորը փորել:

API փաստաթղթերը, որոնց դուք հղում եք կատարում, պետք է ունենա «Պարամետրեր» կամ «Ընտրանքներ» բաժին, որը կոչվում է յուրաքանչյուր վերջնակետի և հարցման տեսակի համար: Ուշադրություն դարձրեք, թե որ պարամետրերն են պահանջվում, քանի որ որոշները պարտադիր չեն: Եթե պարամետրը նշվում է որպես պարտադիր, փաստաթղթերը կարող են բերել օրինակ, որը նաև կանխադրված է:

Slash- ի API պարամետրերը կարող են այսպիսի տեսք ունենալ ՝ գնդակներ գտնելու համար.

ՇՏԱՊԵՔ

Քայլ 6: Ձևակերպեք ձեր հայցը

Մենք ունենք մեզ անհրաժեշտ բոլոր տեղեկությունները, այժմ մեզ մնում է միայն խնդրանքը ներկայացնել:

Ահա API- ին միանալու երկու տարբեր եղանակներ, որոնք կոդ չեն պահանջում: Եկեք միանանք Slash- ի API- ին ՝ նրա գնդակների ցուցակը ստանալու համար ՝ GET հարցում կատարելով

Պարաբոլա. Եթե ցանկանում եք միանալ և աշխատել տվյալների հետ առանց կոդի

Parabola- ն վեբ ծրագիր է, որը թույլ է տալիս հեշտությամբ միանալ API- ներին, այնուհետև տվյալների հետ աշխատել տեսողական, քաշել և թողնել գործիքի միջոցով: