Esempio di output OpenAPI
In questa pagina
Esempio di output OpenAPI
Un esempio reale di ciò che bxSitesOpenApiDoc (Gradle) /
bxsites:openapi (Maven) produce davvero - vedi
Plugin Gradle o
Plugin Maven per sapere come
attivarlo nel tuo progetto.
Punta specFile alla tua specifica OpenAPI generata da springdoc, e il
generatore la copia in assets/openapi/, poi scrive una pagina con
esattamente questo frontmatter e questo corpo:
---
title: "Bookshelf API"
tags: [api, openapi]
---
# Bookshelf API
::: openapi src="assets/openapi/openapi.yaml" title="Bookshelf API"
:::
Ed ecco renderizzato per davvero, proprio su questa pagina, a partire da
una piccola specifica "Bookshelf API" che questo repository già fornisce
in assets/openapi/example.yaml - la
stessa che dimostra OpenAPI / Swagger:
Bookshelf API
Non è uno screenshot né un mockup - è il vero widget interattivo Swagger
UI fornito da bx-sites, alimentato dal file di specifica qui sopra.
Puntato alla specifica del tuo progetto, bxSitesOpenApiDoc/
bxsites:openapi produce un output byte per byte identico.
Cosa non copre
Swagger UI viene renderizzato interamente lato client, quindi il testo
per singolo endpoint (come "List books") non raggiunge mai l'indice di
ricerca di bx-sites - viene indicizzato solo il titolo/frontmatter di
questa pagina. Consulta le guide Gradle/Maven collegate sopra per il
resto dell'ambito v1 (springdoc deve comunque generare tu stesso il file
di specifica; openapi: true deve comunque essere impostato in
bxsites.yaml, sia a mano che tramite autoPatchConfig).