Requisitos: Scalar es bastante potente y puede generar automáticamente código de llamada HTTP en diferentes lenguajes a partir de la documentación de la API, usando Scalar en lugar de Swagger para mostrar la documentación de la API.
Tras el lanzamiento de .NET 9 ASP.NET el equipo oficial de Core anunció que Swashbuckle.AspNetCore (un proyecto que proporciona la herramienta Swagger para la API ASP.NET Core) sería eliminado de la plantilla de la API web ASP.NET Core. Esto significa que en el futuro, cuando creemos proyectos de APIs Web, la documentación de la API de Swagger ya no se generará automáticamente. Así que hoy, probemos a usar Scalar para la documentación interactiva de la API en nuestro proyecto EasySQLite .NET 9.
Enlace:El inicio de sesión del hipervínculo es visible.
Las razones de la destitución de Swagger se pueden resumir de la siguiente manera:
- Deficiente mantenimiento de Swashbuckle: El proyecto Swashbuckle ya no es mantenido activamente por los propietarios de la comunidad, muchos problemas siguen sin resolver y no se ha publicado una versión oficial compatible con .NET 8.
- Pasando a Microsoft.AspNetCore.OpenApi: El equipo de ASP.NET Core mejorará las capacidades de Microsoft.AspNetCore.OpenApi para reemplazar a Swashbuckle y permitir la generación de documentación OpenAPI.
- Alternativas existentes: Además de Swashbuckle, otros proyectos como NSwag soportan la generación de documentación OpenAPI y la generación de código cliente/servidor, permitiendo a los desarrolladores elegir la solución adecuada según las necesidades del proyecto.
- Soporte integrado mejorado para APIs: Desde ASP.NET Core 3.1, el framework ha proporcionado soporte de metadatos como ApiExplorer. Combinado con Visual Studio y el soporte integrado de Visual Studio Code para archivos .http, la experiencia de pruebas y depuración de API es aún mejor.
- Promover OpenAPI como componente central: ASP.NET equipo central planea mejorar aún más la integración de OpenAPI en .NET 9, convirtiéndolo en un componente central centrado en generar documentación OpenAPI con formato JSON.
Escalar
Scalar es una herramienta potente y fácil de usar para la generación de clientes y documentación de API, adecuada para proyectos API de todos los tamaños, que soporta múltiples lenguajes de programación y plataformas.
Dirección de código abierto:El inicio de sesión del hipervínculo es visible.
ASP.NET Core integra Escalar
Documentación integrada:El inicio de sesión del hipervínculo es visible.
Crea un proyecto ASP.NET Core 9, referenciado de la siguiente manera:
Añadir servicios y middleware escalar en Program.cs, con el código siguiente:
Edición WeatherForecastController.cs controlador, código de la siguiente manera:
Lanza el proyecto, abre tu navegador y visita:http://localhost:5088/api-docs, como se muestra en la figura siguiente:
Puedes elegir generar código de llamada específico para bibliotecas HTTP en diferentes lenguajes. Tomando como ejemplo la biblioteca HttpClient de C#, el código generado es el siguiente:
También soporta pruebas de interfaz en línea. Haz clic en el botón Solicitud de Prueba, rellena los datos de la publicación y luego haz clic en enviar para enviar la solicitud, como se muestra a continuación:
Personaliza el cliente HTTP predeterminado. Para los equipos de C#, queremos abrir la interfaz de documentación de la API, que muestra automáticamente el código de llamada HttpClient de C#. Si no quieres seleccionar manualmente cada primera vez, configúralo de la siguiente manera:
Elimina la función Ask AI y elimina el botón Ask AI Agent. Esta función resulta un poco redundante. El código es el siguiente:
Como se muestra a continuación:
Después de la eliminación, como se muestra a continuación:
De manera similar, desactiva la funcionalidad MCP y codifica lo siguiente:
La configuración completa es la siguiente:
Añadir autenticación JWT y llevar la cabecera de la solicitudFicha de portador
Añadir requisitos de seguridad a toda la documentación de OpenAPI, código de la siguiente manera:
Como se muestra a continuación:
OpenID Connect (OIDC):El inicio de sesión del hipervínculo es visible.
Referencia:
El inicio de sesión del hipervínculo es visible.
El inicio de sesión del hipervínculo es visible. |
Publicado enHace 5 minutos
|
|
|
|
Propietario|
Publicado enHace 1 minuto
|
