Best practices URL API

Ciao Developer, in questo articolo ti voglio parlare di best practices URL API, ovvero alcune buone pratiche da applicare quando si progetta e rilascia API.

L’URL dell’API svolge un ruolo importante nell’organizzazione e nella classificazione delle API nella tua organizzazione. Un buon approccio nella definizione dell’URL dell’API aiuta l’organizzazione a classificarli e gestirli bene. Gli URL API devono essere mappati ai domini aziendali e al processo a cui si rivolgono.

Di seguito sono riportati alcuni punti di cui tenere conto durante la definizione degli URL API.

  • Environment : l’URL dell’API dovrebbe essere in grado di dire a quale ambiente appartiene questa API.
  • Organization : l’URL dell’API dovrebbe essere in grado di dire a quale organizzazione appartiene questa API.
  • API layer : l’URL dell’API dovrebbe essere in grado di indicare il livello ( sistema , processo ed esperienza ) a cui appartiene l’API.
  • API Version : l’URL dell’API dovrebbe essere in grado di indicare la versione dell’API.
  • Business Unit : URL API dovrebbe essere in grado di dire la business unit questa API appartiene.
  • Business process : l’URL dell’API dovrebbe essere in grado di indicare il processo aziendale a cui appartiene l’API.
  • Sub business process : l’URL dell’API dovrebbe essere in grado di indicare il processo aziendale secondario a cui appartiene l’API.

Considerando tutti i punti precedenti, possiamo avere URL API come di seguito.

https://api-{env}.{organization}.it/{api–layer}/{api-version}/{business-unit}/{business-process}/{sub-business-process}/{resource}

Di seguito sono riportati gli esempi dei parametri precedenti nell’URL. Dovrai definire le regole di mappatura nel DLB (Dedic Load Balancer) poiché l’URL dell’API di lavoro di Mulesoft non può essere modificato.

ParametroValoriDescrizione
envdev, test, prod
Indica l’ambiente di esecuzione (opzionale per la produzione)
organizationlbonaldoNome dell’organizzazione
api-layere, p, ss per system api, p per process api ed e per experience api. 
Tuttavia, questo non dovrebbe essere esposto a consumatori esterni della tua API. 
Questo parametro dovrebbe rimanere interno, dovresti avere la mappatura DLB per instradare al percorso API interno.
api-versionv1, v2..Versionamento
business-unitfood,
beverages,
confectionery
Potrebbe essere l’unità aziendale della tua organizzazione. 
Considera un’organizzazione FMCG che si occupa di alimenti, bevande, pasticceria
Queste sono alcune unità aziendali tipiche di quell’organizzazione che funzionano in modo indipendente l’una dall’altra
business-processfinance, 
customer, 
order-management
Le aree sotto un’unità aziendale potrebbero essere utilizzate per identificare il processo aziendale. 
Ad esempio finanza , clienti , 
gestione degli ordini, ecc
sub-business-processaccounts, 
payroll, 
payments, 
taxes, 
general-ledgers
Un processo aziendale può essere ulteriormente approfondito fino a un processo aziendale secondario che può aiutare a restringere ulteriormente gli URL API. 
Ad esempio, il processo aziendale 
finanziario può essere approfondito in vari processi aziendali secondari, ad esempio 
conti , buste paga , 
pagamenti , tasse , libri contabili ecc.

Ecco alcuni esempi che potremmo definire considerando la comprensione di cui sopra. “Studenti” e ” insegnanti” sono risorse qui.

https://api-test.lbonaldo.it/v1/trainings/mulesoft/tutorials/students

https://api-test.lbonaldo.it/v1/trainings/mulesoft/tutorials/students

https://api.lbonaldo.it/v1/trainings/mulesoft/tutorials/students

https://api-dev.lbonaldo.it/v2/finance/payroll/teachers

Queste semplici abitudini daranno un gran valore aggiunto ai tuoi progetti.

Grazie per aver dedicato del tempo per leggere questo articolo. Spero tu l’abbia trovato utile. In caso di domande, non esitare a commentare di seguito.

Leggi anche: I love Liquibase

Fonti: API URLs Best Practices – Mulesy

Lascia un commento

Il tuo indirizzo email non sarà pubblicato. I campi obbligatori sono contrassegnati *

13 − dodici =