Profi

Mae profion API yn rhan hanfodol o'r broses ddatblygu ac integreiddio, gan sicrhau bod APIs yn gweithredu'n gywir, yn ddiogel ac yn effeithlon.

Mae'r canllaw hwn ar gyfer darparwyr API a defnyddwyr API, sy'n amlinellu'r achosion defnydd disgwyliedig, gofynion profi, a safonau dogfennaeth sydd eu hangen ar gyfer sefydlu API llwyddiannus.

Ar gyfer cyhoeddwyr API mae'r ffocws ar sicrhau bod yr APIs y maen nhw’n eu datblygu yn gadarn, yn ddiogel ac yn perfformio ar draws pob achos defnydd posibl. Mae hyn yn cynnwys profi pob pwynt terfyn, gwirio cywirdeb data, trin gwallau yn lân, a chadw at brotocolau diogelwch o safon diwydiant.

Ar gyfer defnyddwyr API mae'r broses brofi wedi'i thargedu'n fwy, gan ganolbwyntio ar y pwyntiau terfyn API penodol a'r swyddogaethau y bydd eu cymwysiadau'n eu defnyddio. Rhaid i ddefnyddwyr sicrhau y gall eu cymwysiadau ryngweithio â'r API yn ôl y disgwyl, trin ymatebion API disgwyliedig/annisgwyl yn gywir, a rheoli unrhyw wallau neu bryderon diogelwch a all godi.

Achosion defnydd

Achosion defnydd swyddogaethol

Pwrpas: Gwiriwch fod yr API yn cyflawni ei swyddogaethau arfaethedig yn gywir.

Ar gyfer cyhoeddwyr API:

Gweithrediadau CRUD sylfaenol: Sicrhewch fod gweithrediadau Creu, Darllen, Diweddaru a Dileu (lle bo'n berthnasol) ar draws pob pwynt terfyn yn weithredol, yn dychwelyd y canlyniadau disgwyliedig, a bod ganddynt ffiniau digonol i amddiffyn cyfanrwydd sylfaenol y data.
Dilysu diweddbwynt/manyleb: Gwiriwch fod pob pwynt terfyn API yn ymddwyn yn unol â'i fanyleb, gan ddychwelyd ymatebion cywir ar gyfer amrywiaeth o fewnbynnau dilys ac annilys.
Dilysu data: Dilysu bod pob ymateb API yn cynnwys data cywir a dilys, sy'n gyson â dyluniad a manyleb ddogfenedig yr API.

Ar gyfer defnyddwyr API:

Gweithrediadau sylfaenol: Cadarnhewch fod y pwyntiau terfyn API sy'n cael eu cyrchu yn cyflawni'r gweithrediadau Creu, Darllen, Diweddaru a Dileu angenrheidiol sy'n ofynnol gan y rhaglen.
Rhyngweithio diweddbwynt: Profwch ryngweithiad y rhaglen sy'n cymryd llawer o amser gyda'r pwyntiau terfyn API penodol y bydd yn eu defnyddio. Sicrhewch fod y pwyntiau terfyn hyn yn dychwelyd y canlyniadau disgwyliedig pan gânt eu galw gan y cymhwysiad sy'n cymryd llawer o amser.
Defnydd data: Gwiriwch fod y data a ddychwelwyd gan yr API wedi'i brosesu'n gywir a'i arddangos o fewn y rhaglen sy'n defnyddio llawer yn unol â gofynion y busnes.

Noder: Os oes unrhyw ddata yn cael ei anfon i'r API yna bydd angen i chi weithio gyda'r darparwr i sicrhau ei fod wedi'i fformatio'n gywir, gyda'r holl feysydd disgwyliedig, fel sy'n gyson â'r holl achosion defnydd yr ydych yn eu gwneud ar gael yn eich cais.

Achosion defnydd perfformiad

Pwrpas: Aseswch berfformiad yr API o dan amodau amrywiol.

Ar gyfer cyhoeddwyr API:

Amser ymateb: Mesurwch a gwnewch y gorau o amseroedd ymateb yr API o dan lwythi arferol a brig i sicrhau eu bod yn bodloni safonau perfformiad rhagosodol.
Trin llwyth: Cynhaliwch brofion llwyth helaeth i ddilysu bod yr API yn cynnal perfformiad a sefydlogrwydd o dan amodau traffig uchel, megis ceisiadau cydamserol lluosog.
Profi straen: Cynhaliwch brofion straen i benderfynu sut mae'r API yn perfformio o dan amodau eithafol, gan sicrhau y gall drin pigau annisgwyl wrth ei ddefnyddio ac adfer yn lân.

Ar gyfer defnyddwyr API:

Ymatebolrwydd cymwysiadau: Sicrhewch fod perfformiad yr API (amser ymateb) yn bodloni gofynion y rhaglen ar gyfer darparu profiad defnyddwyr di-dor, yn enwedig o dan sefyllfaoedd defnydd nodweddiadol.
Effaith llwyth: Aseswch sut mae perfformiad yr API o dan amodau llwyth yn effeithio ar y cymhwysiad sy'n defnyddio llawer, yn enwedig os yw'r cymhwysiad yn dibynnu ar ddata amser real neu amser real bron.
Trin gwallau: Dilyswch fod y cymhwysiad sy'n cymryd llawer o bobl yn ymdrin ag unrhyw faterion/gwallau sy'n ymwneud â pherfformiad o'r API yn lân (fel oedi ymateb/goramser, tocyn yn dod i ben, cwota/rhybuddion arestio pigyn).

Achosion defnydd diogelwch

Pwrpas: Sicrhewch fod yr API yn ddiogel ac yn cadw at arferion gorau diogelwch.

Ar gyfer cyhoeddwyr API:

Dilysu ac awdurdodi: Gwiriwch fod mecanweithiau dilysu (e.e. OAuth, allweddi API) yn gweithio yn ôl y bwriad, gan sicrhau mai dim ond defnyddwyr awdurdodedig sy'n gallu cyrchu'r API.
Amgryptio data: Sicrhewch fod data wrth deithio ac wrth orffwys yn cael ei amgryptio i ddiogelu rhag mynediad heb awdurdodi neu doriadau.
Cydymffurfiad diogelwch: Dilyswch yr API yn erbyn protocolau diogelwch o safon diwydiant a gofynion cydymffurfio, e.e. defnyddio asesiad trydydd parti (e.e. prawf treiddio) fel y bo'n briodol.

Ar gyfer defnyddwyr API:

Rheoli tocynnau: Profwch y modd y caiff tocynnau dilysu eu trin yn gywir a'u storio'n ddiogel (e.e. allweddi API, tocynnau mynediad) o fewn y rhaglen sy'n defnyddio llawer.
Rheoli mynediad: Sicrhewch fod y cais defnyddio yn gofyn am y caniatâd angenrheidiol yn unig ac yn cadw at egwyddor y fraint leiaf wrth ryngweithio â'r API.
Data a Diogelwch: Gwiriwch fod data sensitif a dderbynnir gan yr API yn cael ei drin yn ddiogel o fewn y rhaglen, gan gynnwys amgryptio cywir a chuddio data yn ôl yr angen.
Cydymffurfiad diogelwch: Disgwylir hefyd y bydd asesiad trydydd parti (e.e. prawf treiddiad) yn rhagofyniad i gael mynediad i'n APIs.

Achosion defnydd trin gwallau

Pwrpas: Cadarnhewch fod yr API yn trin gwallau yn lân ac yn darparu adborth defnyddiol.

Ar gyfer darparwyr API:

Codau gwall: Sicrhewch fod yr API yn dychwelyd codau statws HTTP priodol ar gyfer gwahanol senarios gwall, megis 400 ar gyfer ceisiadau gwael a 500 ar gyfer gwallau gweinydd.
Gwall wrth gofnodi: Gweithredu mecanweithiau cofnodi gwallau cadarn i gasglu a dadansoddi gwallau ar gyfer gwelliannau yn y dyfodol.
Negeseuon hawdd eu defnyddio: Darparu negeseuon gwall clir, disgrifiadol sy'n helpu defnyddwyr API i ddeall y mater a sut i'w ddatrys.

Ar gyfer defnyddwyr API:

Gwall wrth drin y cais: Profwch allu'r cais defnyddio i drin ac arddangos gwallau API yn gywir, gan sicrhau bod defnyddwyr yn cael adborth priodol heb ddatgelu gwybodaeth sensitif.
Ailgeisio rhesymeg: Gweithredu a phrofi rhesymeg ailgynnig yn y rhaglen ar gyfer ymdrin â gwallau API dros dro neu faterion rhwydwaith.
Hysbysiadau defnyddwyr: Sicrhewch fod y rhaglen yn rhoi negeseuon gwall neu anogwyr ystyrlon i ddefnyddwyr pan fydd gwallau API yn digwydd, gan eu helpu i gymryd camau cywiro os oes angen.

Profi disgwyliadau

Cydymffurfiaeth a phrofion tystion

Mewn rhai achosion, efallai y bydd angen profion cydymffurfiaeth neu brofion tystion i roi sicrwydd ychwanegol bod API yn bodloni'r safonau angenrheidiol ac yn perfformio yn ôl y disgwyl, yn enwedig pan ofynnir amdano gan berchnogion cynnyrch API. Mae'r profion hyn yn arbennig o bwysig ar gyfer APIs sy'n chwarae rhan hanfodol mewn gweithrediadau busnes neu sydd angen cydymffurfio â chanllawiau diwydiant-benodol.

Profi cydymffurfiaeth: Mae hyn yn golygu gwirio bod yr API yn cadw at safonau, protocolau neu ganllawiau diffiniedig. Mae'n hanfodol pan fydd rhyngweithredu ar draws gwahanol systemau yn flaenoriaeth, neu pan fydd yn rhaid i'r API fodloni gofynion rheoleiddio penodol. Mae sicrhau bod API yn cydymffurfio â'r safonau hyn yn helpu i atal problemau wrth integreiddio ac yn cefnogi cydweithredu llyfnach ar draws platfformau.
Profi tystion: Weithiau, mae angen i gynrychiolydd dynodedig neu berchennog cynnyrch arsylwi ar y profion i ddilysu bod yr API yn ymddwyn yn ôl y disgwyl mewn lleoliad byd go iawn. Mae profion tystion yn caniatáu i randdeiliaid allweddol adolygu a chadarnhau bod yr API yn bodloni eu disgwyliadau, gan gynnig lefel o sicrwydd cyn cymeradwyo'r API i'w gynhyrchu. Mae'r adborth amser real hwn yn hanfodol ar gyfer dal problemau posibl yn gynnar a gwneud addasiadau yn ôl yr angen.

Yn dibynnu ar natur a defnydd yr API, gallai'r profion hyn fod yn orfodol cyn cymeradwyo'r cynefino llawn. Bydd canlyniadau cydymffurfiaeth neu brofion tystion yn cael eu dogfennu a'u hanfon yn ôl at berchnogion cynnyrch API i'w hadolygu. Yn ddelfrydol, ni ddylai fod unrhyw faterion mawr ar hyn o bryd gan y dylai'r API fod eisoes wedi pasio profion swyddogaethol, diogelwch a pherfformiad. Mae'r profion hyn yn ymwneud yn fwy â sicrhau aliniad â safonau, protocolau, neu ddisgwyliadau dylunio penodol, yn hytrach na datgelu materion newydd.

Dylai Defnyddwyr API weithio'n agos gyda'r tîm platfform API i benderfynu a oes angen cydymffurfiaeth neu brofi tystion cyn symud ymlaen â'r broses sicrwydd mynediad terfynol.

Prawf sylw

Ar gyfer cyhoeddwyr API:

Sylw cynhwysfawr: Dylai'r Adroddiad Profi gynnwys profion ar gyfer pob pwynt terfyn API, gan gynnwys achosion ymyl, senarios gwallau, a gwendidau diogelwch.
Achosion profi manwl: Dylai pob achos prawf ddisgrifio'r mewnbwn, yr allbwn disgwyliedig, a'r fethodoleg brofi.

Ar gyfer defnyddwyr API:

Sylw wedi'i dargedu: Dylai'r Adroddiad Profi ganolbwyntio ar y pwyntiau terfyn API penodol a'r swyddogaethau y bydd y rhaglen yn eu defnyddio. Nid oes angen profi pob pwynt terfyn os ydynt yn amherthnasol i'r cais.
Achosion prawf perthnasol: Cynhwyswch achosion prawf sy'n adlewyrchu achosion defnydd gwirioneddol y cymhwysiad sy'n cymryd llawer, gyda ffocws ar integreiddio, perfformiad, a thrin gwallau.

Dogfennau

Ar gyfer cyhoeddwyr API:

Adroddiad profion: Dylai'r adroddiad roi cyfrif manwl o'r holl achosion prawf a gyflawnwyd, y canlyniadau a gafwyd, ac unrhyw faterion a gafwyd, gan gynnwys camau i atgynhyrchu bygiau a'u difrifoldeb.
Olrhain bygiau: Dogfennwch ac olrhain yr holl ddiffygion a ddarganfuwyd yn ystod y profion, ynghyd â'u statws datrys.

Ar gyfer defnyddwyr API:

Crynodeb prawf: Darparwch grynodeb o'r profion a gynhaliwyd ar y pwyntiau terfyn API a ddefnyddir gan y cymhwysiad sy'n defnyddio llawer, gan amlygu unrhyw faterion a gafwyd a sut yr aethpwyd i'r afael â nhw.
Nodiadau integreiddio: Cynhwyswch unrhyw nodiadau penodol ar sut y cafodd yr API ei integreiddio i'r cymhwysiad ac unrhyw resymeg arferiad a weithredwyd i drin ymatebion neu wallau API.

Profi Derbynioldeb Defnyddwyr (UAT)

Ar gyfer cyhoeddwyr API:

Adborth rhanddeiliaid: Casglwch a chynhwyswch adborth gan randdeiliaid allweddol a defnyddwyr terfynol i sicrhau bod yr API yn bodloni gofynion y busnes.
Profi defnyddioldeb: Gwiriwch fod yr API yn hawdd i'w ddefnyddio, wedi'i ddogfennu'n dda, ac yn integreiddio'n esmwyth â systemau eraill.

Ar gyfer defnyddwyr API:

Cymhwysiad UAT: Cynnal profion derbyn defnyddwyr gyda'r cymhwysiad gwirioneddol sy'n defnyddio'r API, gan sicrhau ei fod yn bodloni gofynion y busnes ac yn darparu profiad defnyddwyr di-dor.
Adborth defnyddwyr terfynol: Cynhwyswch adborth gan ddefnyddwyr terfynol sy'n rhyngweithio â'r rhaglen i ddilysu bod yr integreiddiad API yn effeithiol ac yn hawdd ei ddefnyddio.

Casgliad

Mae profion API yn gyfrifoldeb a rennir rhwng darparwyr a defnyddwyr, pob un â rolau gwahanol ond cyflenwol. Ar gyfer cyhoeddwyr API, y nod yw darparu API cwbl weithredol, diogel a pherfformiad uchel sy'n diwallu anghenion ystod eang o ddefnyddwyr. Ar gyfer defnyddwyr API, mae'r ffocws ar sicrhau y gall eu cymwysiadau integreiddio'n effeithiol ac yn ddiogel â'r API, gan ddefnyddio'r pwyntiau terfyn angenrheidiol yn unig a thrin ymatebion a gwallau yn briodol.

Trwy gadw at ein canllawiau a'n disgwyliadau, gall darparwyr a defnyddwyr sicrhau bod eu APIs yn ddibynadwy, yn ddiogel, ac wedi'u hoptimeiddio at y dibenion y’u bwriadwyd. Mae'r cydweithrediad hwn yn meithrin proses integreiddio ddi-dor, gan arwain at gymwysiadau cadarn, hawdd eu defnyddio sy'n bodloni amcanion busnes.