5 Mga hakbang sa paglikha ng isang matagumpay na apoy

Ito ay ang likas na katangian ng pag-unlad ng software. Lumilikha ng software ang mga nag-develop sa isip ng end user. Mukhang medyo simple, ngunit kung minsan ang mga gumagamit ay kapwa mga developer. Hindi nila kailangan ang mga bagay na nasira para sa kanila. Hindi nila kailangan kahit na ang pagiging simple. Ang nais nilang ma-access - isang paraan upang maisama ang iyong software sa kanila. Narito ang isang API (interface ng application programming) ay pumapasok., Inaasahan kong i-highlight ang limang mga hakbang na maaari mong gawin upang lumikha ng isang matagumpay na API.

Gawin mo ang iyong Takdang aralin

Pagdating sa pag-unlad ng software, wala sa atin ang nais na muling mabuhay ang gulong. Sa puntong ito, halos lahat ng mga malalaking kumpanya ng Web ay mayroong mga API para sa kanilang mga produkto ng software. Pag-aralan ang mga API at subukang pumili ng iba't ibang mga desisyon ng disenyo na lumilikha sa kanila.

Maraming iba't ibang mga teknolohiya ang naroroon, ngunit ang karamihan sa mga API na makikita mo ay gumagamit ng alinman sa isang RESTful interface, o SOAP. Kung ikaw ay nasa bakod kung saan magagamit ang interface ng API na iyong gagamitin, iminumungkahi ko ang pagpunta sa isang MABUTING pamamaraan gamit ang HTTP protocol. Ito ay mas simple kaysa sa SOAP, kasalukuyan itong mas tanyag, at magiging mas madali itong magsimula kapag gumagamit ng isang produktong software na batay sa Web.

Maging Pare-pareho

Ang isa sa mga bagay na pinapahalagahan ng mga developer ay ang pagiging pare-pareho. Kasama dito, bukod sa iba pang mga bagay, addressability, input argumento, mga format ng output at error handling.

Kapag gumagamit ng isang RESTful diskarte, maraming iba't ibang mga scheme ng pagbibigay ng pangalan sa URI. Ang bawat isa ay may mga tagasuporta nito, kaya pumili lamang ng isa at manatili dito. Ang parehong napupunta sa istraktura ng input at output. Karamihan sa mga API ay sumusuporta sa paggamit ng XML at JSON bilang mga format ng input at output. Iminumungkahi kong suportahan ang pareho, ngunit ang pagpili ng isang default na format.

Para sa pag-input, ang iyong mga kinakailangan sa pag-input ay dapat na pinangalanang palagi at dapat magkaroon ng kahulugan sa konteksto ng tawag sa API na iyong ginagawa. Para sa output, tiyaking gumagamit ka ng karaniwang mga layout ng istraktura ng data. Kung binabalot mo ang output ng isang tawag sa API sa isang XML tag, isaalang-alang ang paggawa nito sa iyong iba pang mga tawag.

Ito ay isang pangkaraniwang kasanayan na isama ang ilang uri ng watawat ng katayuan sa data ng output na ipinadala mo sa kliyente. Kapag gumagamit ng isang RESTful API na diskarte, dapat itong gawin gamit ang mga code ng katayuan ng HTTP. Halimbawa, kung pinoproseso mo lamang ang isang kahilingan sa PUT sa isang umiiral na object ng data, ang code ng katayuan ng HTTP na kasama mo sa iyong tugon ay magkakaiba depende sa kinalabasan ng kahilingan.

Sa halip na isang di-makatwirang watawat na nagpapahiwatig ng katayuan ng tawag, isang pamantayang code ng status na "200 OK" ay maaaring magamit upang tukuyin na ang kahilingan ay matagumpay, habang ang isang "400 Bad Request" na code ng katayuan ay maaaring magamit upang magpahiwatig na ang kahilingan ay malform. Mayroong kaunting mga code sa katayuan ng HTTP na maaaring magamit sa iba't ibang mga sitwasyon.

Gumamit ng OAuth

Karamihan sa mga produkto ng software ay magsasangkot ng ilang uri ng pagpapatunay ng gumagamit upang ma-access ang mga protektadong mapagkukunan para sa gumagamit na iyon. Pagdating sa mga API, ang pagkakaroon ng kliyente na mangolekta ng mga kredensyal ng gumagamit upang maipadala sa iyong server ay isang masamang kasanayan. Dito napasok ang OAuth.

Nagbibigay ang OAuth ng maraming mga benepisyo sa paglipas ng third-party username / password authentication. Higit sa lahat, ang kliyente ay hindi kailanman naka-access sa mga kredensyal ng gumagamit. Ang gumagamit ay nai-redirect sa iyong server kapag siya ay naka-log in. Matapos mag-log in ang gumagamit sa iyong site, muling nailipat siya pabalik sa kliyente kung saan ang kliyente ay makakatanggap ng isang token ng pag-access upang magamit sa mga kahilingan sa protektadong mapagkukunan.

Ang isa pang mahalagang pakinabang ng paggamit ng OAuth ay ang kakayahan ng gumagamit na kanselahin ang pag-access sa kliyente anumang oras. Kung nagpasya ang gumagamit na, sa anumang kadahilanan, hindi nila nais na ma-access ng kliyente ang mga protektadong mapagkukunan para sa kanilang ngalan, pumunta lamang sila sa isang interface na nilikha mo at kanselahin ang pag-access ng kliyente.

Simulan Maaga

Isa sa mga pinakamahalagang bagay na maaari mong gawin upang gawin ang iyong API na isang tagumpay ay upang magsimula nang maaga. Kapag isinulat mo ang pag-andar na iyon upang lumikha ng ilang entry sa iyong database, magpatuloy at kumuha ng labis na oras at magsulat ng isang interface ng API para dito.

Sumulat ng Mahusay na Dokumentasyon

Walang pumapatay sa isang API nang mas mabilis kaysa sa hindi pagkakaroon ng mahusay na dokumentasyon. Habang ang ilang mga developer ay maaaring kumuha ng hindi maayos na na-dokumentong API at alamin kung paano ito dapat gumana, karamihan ay hindi nais.

Dapat mong idokumento ang bawat tawag sa API na mayroon ka at maiuri ang iyong mga tawag sa API ayon sa uri ng data na kanilang ginagawa. Kasabay ng pagdokumento ng mga pagtatapos para sa API na tumatawag sa kanilang mga sarili, dapat mong sistematikong tukuyin ang kinakailangan at opsyonal na mga argumento ng input pati na rin ang mga istruktura ng data ng output. Ang mga argumento sa pag-input ay dapat maglista ng isang default na halaga kung mayroong isa, at ipinahiwatig din ang inaasahang format ng data tulad ng isang numero o string. Panghuli, ang bawat tawag sa API ay dapat magkaroon ng isang listahan ng mga kondisyon ng error at mga code ng katayuan.

Upang maikot ang iyong babasahin, tiyaking isama ang isa o dalawang halimbawa para sa karaniwang mga sitwasyon sa pag-input at output para sa bawat tawag sa API.

Pag-unlad ng API: Panatilihin Ito Nang simple

Bagaman tila ang pagbuo ng isang API ay isang kumplikadong pagsusumikap, ang ideya ng isang API mismo ay hindi isang bagong konsepto at mayroong isang malaking halaga ng magagamit na dokumentasyon sa bawat paksang hinipo namin dito. Siguraduhing gumamit ng mabubuting kasanayan kung saan mahahanap mo ang mga ito, at magbigay ng isang pare-pareho, maayos na na-dokumentong interface.