Vai al contenuto

OpenAPI Specifications

Stato Generazione

Le specifiche OpenAPI vengono generate automaticamente dalle annotazioni JAX-RS/Swagger nei moduli REST.

Servizio Stato Metodo Generazione
ConnessioneService In corso Swagger Maven Plugin 2.1.2 (swagger.yaml)
REST (Quarkus) Disponibile SmallRye OpenAPI (auto-generato in dev mode)
MobileFineAdapter In corso SpringFox Swagger 2.5.0
GecoService Pianificato Da configurare
ElaborazioneService Pianificato Da configurare

Accesso alle Specifiche

REST Quarkus (Disponibile)

In dev mode, la specifica OpenAPI e disponibile a:

http://localhost:8082/q/openapi

Swagger UI:

http://localhost:8082/q/swagger-ui

ConnessioneService

La specifica viene generata dal plugin Maven durante il build:

cd ConnessioneService && mvn swagger:generate

Output: target/swagger/swagger.yaml

MobileFineAdapter

SpringFox genera la documentazione a runtime:

http://localhost:8083/mobile/api/swagger-ui.html
http://localhost:8083/mobile/api/v2/api-docs

Convenzioni API

  • Content-Type: application/json (REST), text/xml (SOAP)
  • Encoding: UTF-8
  • Versioning: Al momento non versionato, previsto per REST Quarkus
  • Errori: Formato standard con codice HTTP + messaggio
  • Paginazione: setFirstResult / setMaxResults a livello JPA