Doc Api
Endpoint /api-docs¶
Las aplicaciones Platform cuentan con un endpoint out-of-the-box el cual nos permite visualizar la especificación OpenApi de nuestra REST API con un generador de documentación llamado swagger-ui.
Como funciona?¶
El acceder al path /api-docs desde el explorador, la aplicación Platform visualizara un documento HTML, el cual necesita del archivo de especificación para ser visualizado. El documento HTML generara un request el endpoint /openapi.yaml en donde espera que este disponible la especificación OpenApi en formato YAML (Se prefiere este formato sobre JSON, ya que es mas fácil de leer y escribir.), en este punto es donde se espera que el desarrollador haga disponible el la especificación en el endpoint esperado.
Como hacer disponible la especificación OpenApi en /openapi.yaml¶
A continuación se muestra un ejemplo de como podemos hacer disponible el archivo con la especificación en el endpoint adecuado. Solo debemos devolver el archivo en la implementacion de la llamada GET /openapi.yaml
using Carter.Response
public class HomeModule : CarterModule
{
public HomeModule()
{
Get("openapi.yaml", async (req, res) => await res.AsFile("openapi.yaml"));
}
}