Actualmente tengo un proyecto MVC en ASP.Net que usa WebApi. La mayor parte del código de los controladores está escrito en C#. Me gustaría generar automáticamente una descripción de las llamadas API que incluye:
1.) La URL de la página/punto final
2.) Descripción de lo que hace el punto final/la página
3.) Lista de argumentos con descripciones y tipos de datos.
4.) Verbo HTTP (obtener, publicar, poner, eliminar)
5.) Los permisos requeridos para la página
La descripción tendrá que ser escrita manualmente.
He leído bastantes otros artículos que dan como resultado que el individuo use una aplicación de terceros como Swagger. ¿Hay algo integrado en ASP.Net para ayudar con esto? Si quisiera intentar generar documentación yo mismo (sin usar software de terceros), ¿cómo comenzaría a crear dicha documentación?
He pasado una buena cantidad de tiempo buscando en Google varias consultas y parece que no puedo encontrar una respuesta.
Editar: ¿Cuál es el beneficio de usar Swagger sobre las páginas de ayuda de ASP.Net en mi caso?
Como alternativa a Swagger, puede utilizar las 'Páginas de ayuda' para ASP.NET Web API.
Las entradas dentro de esta documentación se generan automáticamente y contendrán información como:
URI relativo
Método HTTP
Muestra de datos de solicitud/respuesta
Una descripción del propósito de la API (derivada de comentarios XML)
Si es posible usar un componente de terceros, le recomendaría que use Swagger (use el paquete Swashbuckle NuGet ) para obtener la documentación de la API.
Swagger no solo enumera su api uris. Los usuarios realmente los prueban y ven la respuesta.
Swagger tiene herramientas para crear la documentación antes de implementarla.
También puede agregar una descripción usando los comentarios.