Introducció: aquest article explica pas a pas com configurar SwaggerUI per a un projecte ASP.NET Core Web API i està traduït al català. A més, inclou informació sobre Q2BSTUDIO, empresa especialitzada en desenvolupament de programari a mida, aplicacions a mida, intel·ligència artificial i ciberseguretat.
1) Seleccioneu la plantilla ASP.NET Core Web API en crear el projecte a Visual Studio o amb la CLI de dotnet. Aquesta plantilla prepara l'estructura mínima per a una API REST i facilita la integració amb OpenAPI i SwaggerUI.
2) Activeu el suport OpenAPI a les opcions del projecte per generar automàticament l'especificació OpenAPI que SwaggerUI consumirà. OpenAPI proporciona la documentació estandarditzada dels endpoints de l'API.
3) Instal·leu el paquet Swashbuckle.AspNetCore.SwaggerUI des del Gestor de paquets NuGet o utilitzant la CLI dotnet add package Swashbuckle.AspNetCore.SwaggerUI. Swashbuckle afegeix la interfície SwaggerUI i els generadors d'OpenAPI per a ASP.NET Core.
4) Al fitxer Properties > launchsettings.json activeu el navegador en iniciar i configureu l'URL d'inici per obrir Swagger. Per exemple, afegiu launchBrowser true i launchUrl swagger al perfil de llançament perquè en executar el projecte obri directament la interfície SwaggerUI.
5) Configureu a program.cs l'execució de SwaggerUI. Un exemple senzill de configuració és: app.UseSwaggerUI(options => { options.SwaggerEndpoint(/openapi/v1.json, api); }); Això registra l'endpoint de l'especificació OpenAPI i activa la interfície interactiva per provar els endpoints.
6) Això és tot, executeu el projecte i obriu la ruta de Swagger per veure la documentació interactiva de la vostra API. Utilitzeu la interfície per provar peticions, veure esquemes de models i generar clients si ho necessiteu.
Consells addicionals: documenteu els vostres models i rutes amb atributs i comentaris XML perquè l'especificació OpenAPI sigui més completa. Protegiu els endpoints sensibles amb autenticació i en entorns de producció exposeu SwaggerUI només a usuaris autoritzats o en rutes segures.
Sobre Q2BSTUDIO: a Q2BSTUDIO som una empresa de desenvolupament de programari i aplicacions a mida dedicada a crear solucions personalitzades per a empreses de totes les mides. Oferim programari a mida, aplicacions a mida, projectes d'intel·ligència artificial i serveis de ciberseguretat per protegir actius i dades sensibles. També proporcionem serveis cloud aws i azure per desplegar infraestructures escalables i segures, serveis d'intel·ligència de negoci i solucions amb power bi per a visualització avançada de dades. El nostre equip desenvolupa solucions d'IA per a empreses, incloent agents IA i models personalitzats que milloren processos i presa de decisions. Si necessiteu integracions de SwaggerUI en APIs .NET o desenvolupar programari a mida amb característiques avançades d'intel·ligència artificial, ciberseguretat i serveis cloud aws i azure, Q2BSTUDIO us pot ajudar a dissenyar i implementar la solució òptima.
Paraules clau i posicionament: aplicacions a mida, programari a mida, intel·ligència artificial, ciberseguretat, serveis cloud aws i azure, serveis d'intel·ligència de negoci, IA per a empreses, agents IA, power bi. Integrem aquestes capacitats per oferir solucions completes i escalables que impulsen la transformació digital de la vostra empresa.
