• Passa alla navigazione primaria
  • Passa al contenuto principale
  • Passa alla barra laterale primaria
  • Passa al piè di pagina
Glue Labs

Glue Labs

Trasformiamo le tue idee in prodotti digitali di successo!

  • HOME
  • SOLUZIONI
  • NEWS
  • PRODOTTI
  • CONTATTI
  • CASE STUDY

5 consigli sulla progettazione di API

Adottare processi di revisione della progettazione e definire una comune style guide migliora la qualità e l'utilità delle API

Nel 2016 Google scrisse il documento “API Design Reviews at Scale” perchè aveva notato che un’enorme crescita nel numero di API da gestire stava comportando, per gli utenti, inconsistenze e problemi di usabilità. Per far fronte a tutto questo Google ha instituito un processo leggero, scalabile e distribuito per progettare e revisionare API.

Qualsiasi azienda può beneficiarsi dell’utilizzo di tale processo. Scopriamo di seguito 5 elementi di questo processo per migliorare la progettazione, la revisione della progettazione e l’usabilità delle tue API.

Contattaci subito e senza impegno per consulenza, assistenza e supporto nella progettazione e realizzazione di API.

1 – Prospettive differenti rafforzano la revisione della progettazione delle API

La parte importante è che la progettazione delle API e la revisione non sono orientate al codice sorgente quindi non devi fare code review ma devi rivedere e progettare l’intuitività, la completezza e la consistenza delle API.

Un brain storming con gli stakeholder deve tradursi nella corretta comprensione del problema che l’API risolve sia dal punto di vista dell’utilizzatore diretto delle API, sia dell’utilizzatore finale della funzionalità, sia dei system integrator, sia del business.

Tale attività permette di distribuire l’impegno e renderlo efficace evitando perdite di tempo durante lo sviluppo ed eventuali insuccessi.

2 – La revisione inizia con la descrizione

Ne avevamo parlato nell’articolo “Gli 8 passi del ciclo di vita delle API“; occorre avere un comune linguaggio e descrivere correttamente il funzionamento delle API, per far questo è possibile utilizzare le OpenAPI Specification(OAS), le Postman Collection o anche le AsyncAPI.

A prescindere dalla scelta stilistica è fondamentale che questi “artifact” seguano uno standard coerente e consistente durante tutto il progetto, ciò al fine di utilizzarli sia come baseline per la documentazione delle API sia per l’implementazione di possibili automazioni tecnologiche. In pratica questi “artifact” diventano uno strumento live per l’accrescimento della conoscenza ed il testing.

3 – Definizione delle style guide

In enormi ecosistemi di API è indispensabile che tu definisca una comune style guide semplice da seguire, capire ed implementare. La style guide deve definire i processi su come si contribuisce allo sviluppo delle API, come si modifica e come evolve.

In pratica definire una style guide vuol dire fornire una serie di criteri determinati per ottenere i risultati richiesti dal business, tra questi criteri puoi trovare:

  • metodi di autenticazione;
  • convenzione sull’URI e sui relativi parametri;
  • error handling;
  • struttura e formato del payload;
  • versioning;
  • filtri degli input e degli output.

La style guide, insieme alla descrizione, ti permette anche di mitigare gli impatti del turnover del personale che nell’ambito dello sviluppo è sempre molto dinamico.

4 – Adattare la progettazione all’organizzazione

Sembra ovvio, ma occorre adattare la progettazione e la revisione delle API al tipo di organizzazione, alle funzioni delle API, ai casi di uso ed al motivo che ha portato alla necessità dello sviluppo.

Occorre mediare tra formalizzazione e agilità, pur sembrando un concetto semplice nella pratica è molto complesso ed occorre che tu faccia un’analisi puntuale dei costi e dei benefici dell’applicazione di determinate metodologie anche considerando gli aspetti di sicurezza relativi all’esposizione pubblica delle API.

5 – Feedback Management

Il miglioramento parte grazie alla collaborazione di tutti. Devi essere in grado di instaurare un processo di Feedback Management che ti consenta di ricevere segnalazioni da parte degli stakeholder.

Implementare test e verifiche automatiche ti può garantire il funzionamento di una API ma solo grazie ai feedback degli stakeholder puoi garantirne l’utilità.

Conclusioni

Evitare la revisione della progettazione ed il dar vita a cicli di miglioramento continuo vuol dire condannare il proprio ecocosistema di API ad inconsistenze e problemi. Ha affrontato già questo problema Google risolvendolo applicando processi di progettazione e di revisione della progettazione di API. Rendere operativi i suggerimenti sopra descritti richiede un costante impegno che viene ripagato nel tempo da qualità ed utilità delle API oltre a capacità di adattamento a scenari differenti anche nei team di sviluppo.

Contattaci subito e senza impegno per consulenza, assistenza e supporto nella progettazione e realizzazione di API.

Glue Labs e le API

Abbiamo sviluppato ed integrato API in Web Service e Web Application, Middleware ed Embedded System. Grazie all’esperienza maturata in tantissimi settori, con numerosi Clienti e con un solido gruppo aziendale ti garantiamo le competenze per assisterti e supportarti per qualsiasi tuo progetto di sviluppo e nella realizzazione di API, anche Cloud Native, con garanzia 12 mesi da qualsiasi bug. Contattaci subito e senza impegno per maggiori informazioni.

Continua la lettura

  1. Come la Pubblica Amministrazione può ottenere risorse per la transizione digitale: il progetto PA DIGITALE 2026
  2. Gli 8 passi del ciclo di vita delle API

Categoria: Articoli Tags: API, API Design, openapi, postman, Progettazione API, Web Services

Barra laterale primaria

Cosa facciamo

  • Content Strategy
  • E-Commerce
  • Formazione avanzata Web, Mobile & Cloud
  • IoT – Sviluppo e Integrazione
  • Micro Live Learning(MLL) Web, Mobile & Cloud
  • Project Management Prince2
  • PushAPE
  • Sicurezza ICT
  • Software Aziendali
  • Sviluppo Mobile App
  • Sviluppo, Supporto, Assistenza Tecnica e Hosting Google Cloud
  • System Integration
  • Web Application
  • Web Design

Contatti

Scrivici dal form di contatto

Tel +39 06 56549766
Fax +39 06 21122581
Mail: info@glue-labs.com
Pec: gluelabs@legalmail.it

Dove siamo

Roma: Piazza Don Sturzo 15
Milano: Via Lazzaretto 19
Torino: Via San Domenico 28
Altamura: Via Maggio 1648 24

"*" indica i campi obbligatori

Nome*
Questo sito è protetto da reCAPTCHA e si applicano le Normative sulla Privacy e i Termini di Servizio di Google.
Inviando i tuoi dati accetti le condizioni sulla Privacy. Li useremo per rispondere alle tue domande e richieste.
Consenso*
*
Questo campo serve per la convalida e dovrebbe essere lasciato inalterato.

Siamo parte di

La nostra Agenzia di Marketing

Footer

Partnership



Rimaniamo in contatto

Iscriviti alla nostra newsletter

Nome
Questo campo serve per la convalida e dovrebbe essere lasciato inalterato.

Soluzioni

  • Supporto ed Integrazione di SPID e CIE con OpenID Connect
  • Consulenza e Assessment pre-formazione
  • Integrazione con le API di OpenAI e ChatGPT
  • Corso Cucumber per Javascript
  • Supporto ed Assistenza nell’implementazione ed utilizzo dei Kit di Designers Italia
  • Realizzazione di Tour Virtuali 3D
  • Conferenza/Seminario – Google Cloud Hands On
  • Corso Cacti
  • Backup-as-a-Service in Cloud: come archiviare i dati in maniera sicura ed affidabile
  • Corso Angular 14

Articoli

  • Software report del 2022 e trend per il 2023
  • Come gestire il backup di architetture complesse in maniera sicura ed efficiente
  • Perchè avere un Contact Center as a Service(CCaaS)
  • Come modernizzare applicazioni legacy
  • Cos’è Github Flow
  • Come avere una Data Quality Platform come Twitter
  • Cos’è la Dead letter queue e perchè è importante
  • Jinja: un template engine multiuso per Python
  • Cos’è l’Application Level Encryption(ALE): vantaggi e svantaggi
  • Backup e Disaster Recovery(DR) in un’unica piattaforma

Le nostre sedi

  • Roma, Piazza Don Sturzo 15
  • Milano, Via Lazzaretto 19
  • Torino, Via San Domenico 28
  • Altamura, Via Maggio 1648 24

Contatti

  • Tel. +39 06 87811067
  • Fax +39 06 99335373
  • glue-labs@legalmail.it
  • info@glue-labs.com
  • Facebook
  • LinkedIn
  • Twitter

Scarica app da App StoreScarica app da Play Store


Glue Labs © 2011–2023 | Copyright | Privacy Policy | Company Info | Cookie Policy | Gestione Cookies

Gestisci Consenso Cookie
Usiamo cookie per ottimizzare il nostro sito web ed i nostri servizi.
Funzionale Sempre attivo
La conservazione tecnica o l'accesso sono strettamente necessari al fine legittimo di consentire la fruizione di uno specifico servizio esplicitamente richiesto dall'abbonato o dall'utente, o al solo fine di effettuare la trasmissione di una comunicazione su una rete di comunicazione elettronica.
Preferenze
The technical storage or access is necessary for the legitimate purpose of storing preferences that are not requested by the subscriber or user.
Statistiche
L'archiviazione tecnica o l'accesso che viene utilizzato esclusivamente a fini statistici anonimi. Senza un mandato di comparizione, il rispetto volontario da parte del tuo provider di servizi Internet o registrazioni aggiuntive da parte di terzi, le informazioni archiviate o recuperate solo per questo scopo non possono essere generalmente utilizzate per identificarti. The technical storage or access that is used exclusively for anonymous statistical purposes. Without a subpoena, voluntary compliance on the part of your Internet Service Provider, or additional records from a third party, information stored or retrieved for this purpose alone cannot usually be used to identify you.
Marketing
L'archiviazione tecnica o l'accesso è necessario per creare profili utente per inviare pubblicità o per tracciare l'utente su un sito Web o su più siti Web per scopi di marketing simili.
Gestisci opzioni Gestisci servizi Gestisci fornitori Per saperne di più su questi scopi
Gestisci preferenze
{title} {title} {title}