OpenAPI nel generatore di API dati

La specifica OpenAPI è uno standard indipendente dal linguaggio per la documentazione delle API HTTP. Il generatore di API dati supporta OpenAPI per:

• Generazione di metadati per tutte le entità abilitate per REST definite nella configurazione di runtime
• Compilazione di tali metadati in uno schema OpenAPI valido
• Esposizione dello schema tramite un'interfaccia utente visiva (Swagger) o come file JSON serializzato

Documento di descrizione OpenAPI

Il generatore di API dati genera un documento di descrizione OpenAPI usando la configurazione di runtime e i metadati del database per ogni entità abilitata per REST.

Lo schema viene compilato usando OpenAPI.NET SDK ed è conforme alla specifica OpenAPI v3.0.1. Viene restituito come documento JSON.

È possibile accedere al documento OpenAPI all'indirizzo:

GET /{rest-path}/openapi

[! NOTA] Per impostazione predefinita, il rest-path è api. Questo valore è configurabile. Per informazioni dettagliate, vedere Configurazione REST .

Interfaccia utente di Swagger

L'interfaccia utente di Swagger offre una visualizzazione interattiva basata sul Web dell'API basata sullo schema OpenAPI.

In modalità Development, il generatore di dati API espone Swagger UI all'indirizzo:

GET /swagger

Questo endpoint non è annidato in rest-path per evitare conflitti con le entità definite dall'utente.