LabCollector  cuireann roghanna éagsúla socraithe suas. Tá sé réidh le húsáid (a mhéid is féidir), is féidir a chumraíocht a bhainistiú go héasca ag an Sár-Riarachán chun do riachtanais saotharlainne ar leith a chomhlíonadh. Mar chuid de seo, LabCollector soláthraíonn a Chomhéadain Swagger a chuireann ar do chumas iniúchadh agus tástáil a dhéanamh ar an REST API.

Slogtar Is comhéadan gréasán-bhunaithe é a sholáthraíonn bealach éasca le húsáid chun idirghníomhú leis an API. Ligeann sé d’úsáideoirí féachaint ar na críochphointí API atá ar fáil, a bparaiméadar, agus na freagraí a fhilleann siad. Is féidir le húsáideoirí iarratais a sheoladh chuig an API freisin agus féachaint ar na freagraí isteach fíor-ama.

Sa Bhonn Eolais seo a leanas, féachfaimid leat conas úsáid a bhaint as an mBonn Eolais LabCollector's Swagger, clúdóimid freisin conas rochtain a fháil ar Chomhéadain Swagger, conas na críochphointí API atá ar fáil a iniúchadh agus a thástáil, agus conas doiciméadú a ghiniúint go huathoibríoch bunaithe ar shonraíocht OpenAPI.

1. Conas is féidir liom rochtain a fháil LabCollector'S Swagger?

2. Conas críochphointí API a thástáil?

1. Conas is féidir liom rochtain a fháil LabCollector'S Swagger?

Chun API do sheirbhísí gréasáin a chumrú, níl le déanamh ach dul go dtí admin -> EILE -> SETUP -> API Seirbhísí Gréasáin:

• Réimse nua feidhmchlár bunaithe ar do LabCollector is féidir mar shampla a chur i bhfeidhm agus a fhorbairt.
• Ag baint úsáide as LabCollector mar bhunachar sonraí backend, is féidir leis an saotharlann faisnéis iargúlta a sholáthar i gcatalóga seachtracha, acmhainní bitheolaíocha, etc.
  
• LabCollector cuireann sé seirbhísí API ar fáil duit ar féidir leo cabhrú leat feidhmchlár tríú páirtí a nascadh le LabCollector.

           * Le haghaidh tuilleadh eolais, déan tagairt dó seo le do thoil KB.

Is féidir teacht ar Swagger go héasca trí chliceáil ar an deilbhín oráiste suite ar thaobh na láimhe deise den fheidhmchlár is mian leat a chomhtháthú (mar a thaispeántar sa screenshot thíos).

Nuair a bheidh tú cliceáil ar an deilbhín Swagger comhfhreagrach, feicfear mír aníos nua a thaispeánfaidh an teachtaireacht “D'fhéadfadh sé cúpla soicind a ghlacadh chun swagger a ghiniúint“. Ós rud é gur féidir roinnt ama a ghlacadh chun sonraíocht OpenAPI a ghiniúint ag brath ar chastacht an API féin. Nuair atá tú réidh, níl le déanamh ach cliceáil ar “Cruthaigh Swagger don aip seo” chun rochtain a fháil ar Chomhéadain Swagger.

Má chruthaigh tú Swagger roimhe seo le haghaidh aip, osclóidh cliceáil ar an deilbhín Swagger preabfhuinneog a thugann an rogha duit an Swagger reatha a thaispeáint nó é a athnuachan chun ceann nua a ghiniúint. Tá sé seo úsáideach go háirithe má tá athruithe déanta ar an API ón uair dheireanach a gineadh an Swagger.

Taispeánann an aníos freisin an uair dheireanach a nuashonraíodh an Swagger, rud a chabhraíonn leat súil a choinneáil ar bhailíocht an Swagger agus is féidir a bheith an-úsáideach le haghaidh APIanna móra a nuashonraítear go minic.

Mar shampla, is dócha go bhfuil roinnt athruithe déanta agat ar do chuid LabCollector Críochphointí API, mar shampla paraiméadair a chur leis nó a mhodhnú, agus ba mhaith leat a chinntiú go léiríonn an Swagger na hathruithe seo go cruinn. Sa chás sin, is féidir leat an Swagger a athnuachan go simplí trí chliceáil ar an gcnaipe athnuachan, agus ginfear Swagger nua leis an bhfaisnéis nuashonraithe.

1. Conas críochphointí API a thástáil?

Nuair a bheidh Swagger cruthaithe agat don aip roghnaithe agat, déanfar tú a atreorú go huathoibríoch chuig comhéadan Swagger UI, a thaispeánann liosta de chríochphointí API atá ar fáil ar thaobh na láimhe clé den scáileán (mar a thaispeántar sa scáileán thíos). Ligeann an comhéadan so-úsáidte seo duit cumais an API a iniúchadh go héasca, é a thástáil, agus doiciméid a ghiniúint bunaithe ar shonraíocht OpenAPI.

Ansin, cliceáil ar chríochphointe chun a shonraí a fheiceáil, lena n-áirítear a paraiméadair agus na freagraí a thugann sé ar ais, Inár sampla, is féidir linn na modúil go léir agus a gcríochphointí comhfhreagracha a fheiceáil, in éineacht le cur síos gairid ar a ngníomh. Mar shampla, is féidir linn é sin a fheiceáil GET/strains oibríonn sé ar thaifid a fháil ón modúl Strains & Cells, POST / brúnna oibríonn sé ar thaifid a chur leis an modúl céanna ... etc.

Chun críochphointe a thástáil, cliceáil ar an “Iarrai E amach” cnaipe agus cuir isteach na paraiméadair riachtanacha (mar a thaispeántar sa screenshot thíos). Tá sé seo ina chuidiú go háirithe agus críochphointí nua á bhforbairt agus á dtástáil agat sula ndéantar iad a chomhtháthú le d’iarratas.

Ar deireadh, nuair a bheidh do pharaiméadair go léir curtha isteach agat, cliceáil ar an “Rith” cnaipe chun an t-iarratas a sheoladh chuig an API agus féachaint ar an bhfreagra.

Is féidir leat toradh d’iarrata a fheiceáil ansin, in éineacht le gach iarratas dona / neamhúdaraithe / toirmiscthe má bhí aon cheann ann.

Ina theannta sin, ceadaíonn an Chomhéadain Swagger duit doiciméadú a ghiniúint go huathoibríoch bunaithe ar shonraíocht OpenAPI. Is féidir an doiciméadú seo a íoslódáil i bhformáidí éagsúla, mar PDF nó JSON, agus is féidir iad a úsáid chun cumais an API a chur in iúl d’fhorbróirí eile.