Documentazione dell'API REST del generatore di API dati con Swagger /OpenAPI
La specifica OpenAPI è uno standard agnostico del linguaggio di programmazione per documentare le API HTTP. Generatore API dati supporta lo standard OpenAPI con la possibilità di:
- Generare informazioni su tutte le entità definite dalla configurazione di runtime abilitate.
- Compilare le informazioni in un formato corrispondente allo schema OpenAPI.
- Espone lo schema OpenAPI generato tramite un'interfaccia utente visiva (Swagger) o un file serializzato.
Documento di descrizione OpenAPI
Generatore API dati genera un documento di descrizione OpenAPI usando la configurazione di runtime fornita e i metadati dell'oggetto di database per ogni entità abilitata per REST definita. Il file di schema viene generato usando la funzionalità fornita dall'SDK di OpenAPI.NET. Attualmente, il file dello schema viene generato in conformità a OpenAPI Specification v3.0.1 formattato come JSON.
Il documento di descrizione OpenAPI può essere recuperato da Generatore API dati dal percorso:
GET /{rest-path}/openapi
Nota
Per impostazione predefinita, il rest-path valore è e è api configurabile. Per altre informazioni, vedere Configurazione REST
SwaggerUI
L'interfaccia utente di Swagger offre un'interfaccia utente basata sul Web che fornisce informazioni sul servizio usando la specifica OpenAPI generata.
In Development modalità Generatore API dati consente di visualizzare il documento di descrizione OpenAPI generato da un endpoint dedicato:
GET /swagger
L'endpoint "Swagger" non è annidato sotto l'oggetto rest-path per evitare conflitti di denominazione con entità configurate di runtime.