Specifica OpenAPI

Le definizioni OpenAPI di Amica sono documenti conformi alla specifica OpenAPI che descrivono in modo completo l'API, con tutti i metodi e i modelli disponibili documentati nel dettaglio.

Una specifica OpenAPI è una fonte di documentazione sempre aggiornata ed è utilizzabile da numerosi strumenti disponibili online, ad esempio per l'auto-generazione dei client. La nostra API Reference interattiva è generata direttamente dalla specifica OpenAPI.

Dove trovarla

• API Reference interattiva (Stoplight Elements): https://customerws1.amica20.it/api/v3/docs
• Specifica in formato JSON: https://customerws1.amica20.it/api/v3/swagger.json
• Repository versionato: la specifica curata e taggata a ogni rilascio è pubblicata su github.com/amica-dev/openapi.

Sei libero di usarla come preferisci. Se realizzi qualcosa e vuoi condividerlo con altri sviluppatori (o promuoverlo presso gli utenti Amica), faccelo sapere.

Generare un client

A partire dalla specifica puoi generare un client nel linguaggio che preferisci con OpenAPI Generator:

openapi-generator-cli generate \
  -i https://customerws1.amica20.it/api/v3/swagger.json \
  -g <linguaggio> \
  -o ./amica-client

Risorse OpenAPI

• OpenAPI Initiative
• Specifica OpenAPI
• OpenAPI Tools
• OpenAPI Generator