Swagger dans votre projet .NET Core

Dans cet article, nous allons voir comment intégrer swagger dans votre application .NET core. Swagger va vous permettre de décrire, utiliser, et visualiser les services de votre api RESTful.

La première étape va être de rajouter le package Swashbuckle (https://github.com/domaindrivendev/Swashbuckle) qui intègre facilement Swagger.
Dans notre Visual Studio, un petit click droit sur notre projet > Manage nuget package et on va rechercher installer swashbuckle à notre projet.

Maintenant il nous reste à configurer et indiquer que l’on veut que notre API soit documenter par swashbuckle.

Pour se faire, rendez-vous dans le fichier Startup.cs

On va configurer notre service swashbuckle ou l’on peut définir une version, un nom …

        public void ConfigureServices(IServiceCollection services)
        {
            // Add framework services.
            services.AddMvc();
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
            });
        }

Ensuite dans la méthode Configure, on va lui préciser d’utiliser swagger ainsi que l’UI

            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "CoreProjectWithSwagger");
            });

Et c’est tout ! Pour tester, lancez votre projet, rendez-vous ensuite sur http://localhost:PORT/swagger/ et l’ui est disponible sur base des controllers présent dans votre projet.

Code du projet

Vous pouvez retrouver le code du projet sur mon github : https://github.com/MatthieuVdh/CoreProjectWithSwagger

1 Comment

Post a Comment