An bhfuil do Dhréim-Phointí REST API á socrú go ceart agat?

An bhfuil tú ag socrú REST API Endpoints i gceart?

An bhfuil tú ag socrú do chuid API endpoints i gceart? Is minic, nuair a bhímid ag socrú endpoints do ár APIs, a thagann muid ar chásanna inar bhfuil amhras orainn cibé ar chóir dúinn a bheith i bhfoirm iolra nó uatha. Ar chóir dúinn tréscoraidí a úsáid nó fleiscíní? Conas IDanna a lua? I gcás API a bhíonn ag cruthú acmhainne ar chóir dúinn /resource/create a úsáid? Agus go leor eile. Mar sin, ligimis dúinn dul i ndomhain i gconbhinsiúin ainmnithe do REST APIs. Anseo beidh muid a chumhdach:

• Endpoints
• Modhanna
• Leagan

Endpoints

Ligimis dúinn a thosú le roinnt chonbhinsiúin ainmnithe REST API a iniúchadh.

Acmhainní mar Ainmnní

Ba chóir go mbeadh REST APIs ábalta acmhainne a láimhseáil trí úsáid a bhaint as ceann de na príomhmodhanna HTTP. Níor chóir go léireodh na REST URIs aon chineál oibreachta CRUD. Ba chóir dóibh tagairt do acmhainne in ionad gníomh/briathar. Nuair a bhíonn sé indéanta, úsáid foirmeacha iolra na n-ainmnní amháin, mura bhfuil siad ina n-acmhainní aonair.

Samplaí Maithe:

• https://api.website.com/v1/store/products
• https://api.website.com/v1/store/customers
• https://api.website.com/v1/store/discounts

Samplaí Dona:

• https://api.website.com/v1/store/createproducts
• https://api.website.com/v1/store/updatecustomers
• https://api.website.com/v1/store/getdiscounts

Ordlathas

Sainítear an t-ordlathas idir acmhainní agus bailiúchán trí úsáid a bhaint as fleiscíní.

"Cosúil le gach rud i gceird an Fhorbairt Bhogearraí, tá ainmniú ríthábhachtach do thairbhe"

Sampla Maith:

• https://api.website.com/v1/item/store

Sampla Dona:

• https://api.website.com/v1/store/items

Fleiscíní

Ghlactar go foluain go bhfuil fleiscíní a léamh ( first-name ) níos soiléire agus níos barúil don úsáideoir ná tréscoraidí a léamh ( first_name ). Mar sin, nuair a bhíonn focal iolracha i endpoint REST API, is fearr i gcónaí fleiscíní a úsáid in ionad tréscoraidí. Ar bharr sin, tá uillinn ann ó thaobh SEO de freisin. Moltar fleiscíní a úsáid toisc go gcabhraíonn sé do bhots na coincheapa san URL a aithint níos éasca. Agus meastar gur focal amháin is ea tréscor idir dhá fhocal, ach meastar go bhfuil dhá fhocal ar leith ann agus fleiscíní á úsáid.

Sampla Maith:

• https://api.website.com/v1/store/inventory-management/active-orders

Sampla Dona

• https://api.website.com/v1/store/inventory_management/active_orders

Modhanna

Tá a fhios againn anois gan briathair a úsáid inár REST API endpoints, ach cuireann sé ceist orainn conas an briathar a shonrú. Chuige sin, tá HTTP Methods againn chun cabhrú. Is iad HTTP Methods na briathair a léiríonn an cineál oibríochta a d'fhéadfadh an API a bheith a dhéanamh.

Modhanna HTTP:

• Freagraíonn GET don oibríochta "Léigh" acmhainne nó bailiúchán.
• Freagraíonn POST don oibríochta "Cruthaigh" acmhainne nó bailiúchán.
• Freagraíonn PUT don oibríochta "Nuashonraigh" acmhainne nó bailiúchán.
• Freagraíonn DELETE don oibríochta "SCRIOS" acmhainne nó bailiúchán.

Tá 39 HTTP Methods ann ar fad ach GET, POST, PUT & DELETE an fhéad is coitianta agus na modhanna bunúsacha. Beidh muid a chumhdach ar fad na HTTP methods agus a gcásanna úsáide i mblag ar leith.

Leagan

Is fearr i gcónaí do apis a leagan. Is féidir na URLs céanna a úsáid gan a bheith ag déanamh aon athruithe móra i REST API endpoints. Níor chóir endpoints API a bheith neamhbhailí riamh toisc go bhféadfadh sé torthaí gan bhfios a bheith ag an fheidhmchláracha ag iompar iad.

Samplaí:

• https://api.website.com/v1/store/items
• https://api.webiste.com/v2/store/employees

Pointí Ábhartha

• Úsáid Ainmnní chun acmhainní a léiriú.
• Seachnaigh briathair a úsáid i REST API endpoints.
• Ná úsáid tréscoraidí (`_`) in endpoint. Is fearr fleiscíní (`-`) a úsáid ina ionad.
• Úsáid Fiosrúchán chun bailiúchán API a scagadh, a shórtáil nó a theorannú.
• Ná cuir isteach síneadh comhaid ar na URLs. Más mian leat an cineál ábhair a shonrú, úsáid an `Content-Type` header.
• Is fearr i gcónaí litreacha beaga a úsáid i REST API endpoints.
• Ná cuir fleiscíní trailing (`/`) i Rest APIs endpoints. Ní dhéanann siad aon luach séimeantach agus is féidir leo a bheith mearbhall.
• Roghnaigh ainmneacha simplí. Má dhéantar é i gceart, beidh API endpoints an-éasca do aon fhorbróir a chuimhneamh nó a fhíorú.