APIсиз APIге туташуу: 8 кадам

2024 Автор: John Day | [email protected]. Акыркы өзгөртүү: 2024-01-30 10:38

Бул колдонмо APIди колдонууну талап кылган, бирок кантип баштоо керек экенин так билбеген адамдар үчүн иштелип чыккан. Сиз API менен иштөө эмне үчүн пайдалуу экенин мурунтан эле билесиз жана бул колдонмо муну кантип жасоону көрсөтөт.

Эгер бул сизге окшош болсо, анда сиз ийгиликсизсиз! Биз API менен кантип иштөө керектигин, API документтерин кантип окуу керектигин жана APIден кайтып келген маалыматты кантип колдонуу керектигин түшүндүрүп берүү үчүн келдик.

Биз саякатты жеңилдетүү үчүн досубузду алып келдик.

Слэш менен таанышуу

Slash - Мишелдин сүйкүмдүү, сүйкүмдүү ити (жогорудагы сүрөттө). Мишель - API түзүүчү программалык камсыздоо инженери. Мишель чынында эле өзүнүн жумушунан ырахат алат жана Slashти үйрөтүүдө өзүнүн API түзүү APIлеринен илхам алган.

Белгилүү болгондой, API - бул колдонуучу веб -кызматка бере ала турган буйруктардын жыйындысы жана суроо -талапка жооп берген жооптордун жыйындысы. Мишель Слашты так ошондой кылууга үйрөткөн. Слэш жакшы бала, ар кандай буйруктарды билет жана ага үйрөтүлгөн өтүнүчтү бергениңде дайыма туура жооп берет. Ал ашыкча толкунданганда, анын куйругу жинди болуп калат - бул Мишелдин APIлерге байланыштуу үйрөткөнү эмес, болгону ал сүйкүмдүү күчүк болгондуктан жана анын тарбиясын абдан жакшы көрөт!

1 -кадам: Сизге кандай API керек экенин чечиңиз

Кандай маалыматты издеп жүрөсүз же өзгөрткүңүз келет?

Сиз @dougthepugдын Инстаграмдагы билдирүүлөрүнүн баарын тартып алууга аракет кылып жатасызбы? Балким, сиз итиңиздин твиттерин ээрчигендерге автоматтык түрдө твит кылгыңыз келет (анткени иттер сүйлөй албаса дагы, алар көп нерсени айтышат, биз билебиз, Slash албетте).

Эгер сиз туташкыңыз келген сайтты же APIди мурунтан эле билсеңиз, 2 -кадамга өтүңүз. Эгерде сиз маалыматты табууга аракет кылып жатсаңыз, бирок эмнеден баштаарыңызды билбей жатсаңыз, Google сиздин досуңуз. "[Сизди кызыктырган нерсе] API" издеп, эмне болорун көрүңүз. Ал жерде канча маалымат бар экенине таң калышыңыз мүмкүн.

Эгерде сиз жөнөкөй мисал API кааласаңыз, Slashти үйрөтүү учурунда Мишелди колдоно аласыз. Бул анын топторду алуу жана чуңкурларды казуу сыяктуу сүйүктүү буйруктарына ээ. Биз аны калган мисалдарыбызда колдонобуз.

2 -кадам: API документтерин табыңыз

Белгилүү компаниялар тарабынан берилген APIлерде аларды кантип колдонуу керектиги тууралуу толук документтер болушу керек.

Муну табуу үчүн, google "[Insert Company] API документация" же "[Insert Company] developer".

Жыйынтыктар сизди иштеп чыгуучу порталына алып барышы керек. "Docs", "Documentation", "Reference" же "Technical Reference" деп жазылган шилтемени издеңиз.

Документтердин ичинен сизге керектүү APIди издөө керек болушу мүмкүн, анткени кээде көптөгөн параметрлер болушу мүмкүн. Facebook, мисалы, маркетинг, жарнактар, баракчалар жана башкалар үчүн өзүнчө APIлерге ээ.

Эгерде сиз туташкыңыз келген API жакшы белгилүү болбосо (Slash сыяктуу), иштеп чыгуучудан документтерди сурашыңыз керек болот. Алар сизге керектүү маалыматты камтыган PDF же веб -сайтында тизмеленбеген онлайн документтери болушу мүмкүн.

Эгер сиз мурунку кадамда шилтемени өткөрүп жиберген болсоңуз, анда Slashтин API документтерин бул жерден тапса болот.

3 -кадам: Акыркы чекитти табыңыз

API документтери оор көрүнүшү мүмкүн, бирок сиз эмнени издөө керек экенин билгенден кийин, алар адатта жакшы структураланган жана стандартташтырылган.

Биринчи нерсе - бул ылайыктуу акыркы чекит (тер). Сиз каалаган маалыматтын ар бир түрүнө туура келген бир чекит болушу керек. Акыркы чекит мындай көрүнүшү мүмкүн:

slashtheapidog.com/api/bones/{id}

же жөн гана

/сөөктөр

Документтерде акыркы чекиттердин тизмеси болушу керек. Алар документтерде же "шилтеме", "акыркы чекиттер" же "методдор" деп аталган бөлүмдүн астында болушу мүмкүн. Туура чекитти табуу үчүн, сиз издеп жаткан маалыматка дал келген атты издеңиз. Мисалы, эгер сиз Slash казган бардык тешиктердин тизмесин кааласаңыз, /тешиктер, балким, туура. Кандай болбосун, ар бир акыркы чекиттин эмне кылып жатканын түшүндүрүүгө жардам берүүчү сүрөттөмөсү болууга тийиш.

Анын документтеринен, бул тешиктерге байланыштуу Slash APIнин акыркы чекиттери:

Get

Get

POST

КОШУУ

ЖАРЫЯ

4 -кадам: Сиздин суроо түрүн аныктоо

Эми сиз туура чекитти тапкандан кийин, аны жөнөтүү үчүн өтүнүч түрүн аныкташыңыз керек.

Сурамдардын 4 түрү бар:

АЛУУ

GET өтүнүчү - бул APIден, көбүнчө маалыматы бар нерсеге жооп берүүсүн суранууңуз. Сиз акыркы чекитке жана параметрлерге негизделген бир пункт же буюмдар тобу жөнүндө конкреттүү маалыматты сурасаңыз болот. Бул Slashден сизге анын сөөктөрүнүн бирин же анын бардык сөөктөрүн алып келүүсүн сураганга барабар.

POST

POST сурамы - бул APIге жаңы нерсени түзүүнү айтуу. Бул Slashден сиз үчүн жаңы тешик казууну (жаратууну) сураганга окшош.

PUT

PUT сурамы - бул APIге мурда түзүлгөн нерсени жаңыртууну айтуу. Бул Слаштан казган тешигине тереңирээк (жаңыртуу) өтүүнү сураганга окшош.

ЖОЮ

ЖОЮ сурамасы - бул APIге мурда түзүлгөн нерсени жок кылууну айтуу. Бул Slashтен мурун казган тешигин жабууну (жок кылууну) суранганга окшош.

Бул төрт түрү жөнүндө ойлонуп көр. Сиз маалымат алып жатасызбы, жаңы жазууну түзөсүзбү, бар жазууну өзгөртөсүзбү же жок кыласызбы? Бул жооп сизге кайсы суроо түрү керек экенин так айтат.

5 -кадам: Параметрлерди түшүнүңүз

Көптөгөн өтүнмөлөр кошумча параметрлерди талап кылат. Параметрлер - бул сиздин сурооңуздун чоо -жайы. Мисалы, эгер сиз Slash сизге кызыл түстөгү бардык топторду алып келишин кааласаңыз, анда түсүн көрсөтүшүңүз керек. Эгер сиз анын жаңы тешик түзүшүн кааласаңыз, аны кайда коюу керек жана канчалык терең казуу керектигин айтышыңыз керек.

Сиз кайрылып жаткан API документациясында ар бир акыркы чекит жана суроо түрү үчүн "Параметрлер" же "Жолдор" деп аталган бөлүм болушу керек. Кандай параметрлер талап кылынганына көңүл буруңуз, анткени кээ бирлери милдеттүү эмес. Эгерде параметр милдеттүү эмес деп белгиленсе, документтерде демейки мисал келтирилиши мүмкүн.

Slashдин API параметрлери топторду алуу үчүн ушундай көрүнүшү мүмкүн:

Get

6 -кадам: Сурамыңызды форматтаңыз

Бизге керектүү маалыматтын баары бар, эми биз жөн гана өтүнүч кылышыбыз керек!

Бул жерде эч кандай код талап кылынбаган APIге туташуунун эки башка жолу бар. Https://slashtheapidog.com/api/balls дарегине GET суроо берүү менен анын топторунун тизмесин алуу үчүн Slash'дин APIсине туташалы.

Парабола - эгер сиз кодсуз маалыматтарга туташууну жана алар менен иштөөнү кааласаңыз

Parabola-бул APIлерге оңой туташууга, андан кийин визуалдык, сүйрөө-таштоо куралы аркылуу маалыматтар менен иштөөгө мүмкүндүк берген желе колдонмосу.