Creare API interoperabili, dove partire?

Così vuoi creare un’API e non sai da dove iniziare.

Qui trovi un api-starter-kit che, partendo da un openapi-v3:

  • descrive un microservizo che ritorna un timestamp in formato RFC5424
  • genera un server stub in python
  • serve il microservizio in https

Sappiamo che molti generatori di codice supportano solo le vecchie specifiche swagger-2. Che fare allora?

  • innanzitutto verificate che non siano stati rilasciati nuovi code-generator (lo sviluppo su questo fronte è molto attivo)

  • se non lo avete trovato, potete comunque scrivere le specifiche in openapi v3 e convertirle in v2 con api-spec-converter, che è stato patchato di recente per supportare meglio alcuni casi. Ovviamente la v3 ha delle feature in più - che possiamo conservare a livello di specifica.

  • se avete specifiche in swagger-2 invece potete:

    • convertirle in openapi-3
    • arricchirle con tutte le opzioni in più messe a disposizione dalla nuova specifica
    • ricondurvi al caso precedente :wink:

Leggete poi i tanti post sull’interoperabilità che sono su questo forum!

2 Mi Piace

Il link non sembra attivo

Ciao @aborruso,

fixed! Grazie per la segnalazione!

Per qualsiasi cosa fai sapere anche a roberto@teamdigitale.governo.it.
R.

1 Mi Piace

Ciao @aborruso

ho aggiunto un’API autogenerata in Java a partire da openapi v3 https://github.com/teamdigitale/api-starter-kit

e che supporta anche un’endpoint di test che ritorna randomicamente anche risposte 503 e 429.

Tester benvenuti!

1 Mi Piace