Kuhusu tangazo hili
Pale nyaraka nyingi za API zinapokosea
Miongozo mingi huorodhesha ncha za miisho (endpoints) lakini huacha maelezo ambayo kwa kweli husababisha utata: jinsi uthibitishaji unavyofanya kazi kivitendo, mifano kamili ya maombi na majibu, na maana ya hitilafu mahususi pamoja na jinsi ya kuzitatua. Hili linapotokea, wasanidi programu hulazimika kuwasilisha tiketi za usaidizi, jambo linalopingana na kusudi kuu la kuwa na nyaraka.
Mtazamo wetu
Tunaunda moja kwa moja kutoka kwenye msimbo wako wa chanzo badala ya kutegemea dhana. Tunakagua njia zako, mantiki ya uthibitishaji, na ushughulikiaji wa hitilafu, kabla ya sisi wenyewe kujaribu API kwa kutumia vitambulisho halisi. Kila mfano katika nyaraka ya mwisho unawakilisha ombi halisi tulilotuma na jibu tulilopokea, ili kuhakikisha hakuna maelezo ya kubuni au misimbo ya hali isiyowezekana.
Kile unachopokea
- Mwongozo wa uthibitishaji: utoaji wa tokeni, kuhuisha, na kile kinachotokea ikiwa itakwisha muda katikati ya kipindi.
- Ufafanuzi kamili wa kila ncha ya mwisho (endpoint), ikiwa ni pamoja na vigezo, ombi la mfano linalofanya kazi, na muundo halisi wa majibu.
- Rejeleo la hitilafu linalounganisha kila msimbo na chanzo chake pamoja na suluhisho, si kurudia tu ujumbe huo.
- Njia ya kuanza haraka iliyoundwa kumwezesha msanidi mpya kuanzia mwanzo hadi kufanikisha wito wa kwanza.
- Vidokezo kuhusu viwango vya juu vya maombi (rate limits), uwekaji kurasa (pagination), webhooks, na idempotency popote vinapohusika.
Muundo wa uwasilishaji
Tunatoa Markdown inayofaa hazina yako ya msimbo (repository), iliyopangwa vizuri ili kutoshea OpenAPI au tovuti ya nyaraka, yoyote ile ambayo timu yako itaendelea kuisasisha. Sampuli za msimbo hutolewa katika lugha ambazo watumiaji wako wanazitegemea na hujaribiwa kwa kuziendesha. Mkusanyiko wa mtindo wa Postman unaweza kujumuishwa ukiomba.
Kile tunachohitaji kutoka kwako
Ufikiaji wa hazina yako au faili ya OpenAPI, kitambulisho kinachofanya kazi kwa mazingira ya majaribio, na maswali ambayo wafanyakazi wako wa usaidizi hujibu mara kwa mara - haya ndiyo yanayoongoza muundo wa mwongozo.
Kile ambacho hakijajumuishwa
Huduma hii inashughulikia nyaraka sahihi za kiufundi kuhusu jinsi programu inavyofanya kazi; maandishi ya matangazo au masoko ni kazi tofauti.
Mchakato na muda
Utapokea rasimu ya kwanza iliyokamilika, ambayo unaweza kuikagua kulingana na maswali yanayojirudia ambayo timu yako ya usaidizi hupokea. Ni afadhali mhandisi aonyeshe changamoto au kisa maalum mapema kuliko kutoa kitu kilichoboreshwa kijuujuu lakini kisicho sahihi. Kwa kuwa kila mfano umejaribiwa kwenye API yako ya moja kwa moja, hakuna kitu cha kinadharia katika waraka wa mwisho.
Kifurushi hiki kinashughulikia upeo mmoja wa nyaraka za API wenye bei thabiti uliowasilishwa kwa awamu moja, ukiwa na mzunguko mmoja wa marekebisho, kwa 500.99 USD na muda wa utekelezaji wa siku 10. Utahitaji kutoa kikoa (domain) ambacho agizo linahusiana nacho na maelezo yako mafupi ya mradi.