swagger uiをasp.net coreに統合する原理

  public void ConfigureServices(IServiceCollection services)
        {
            // Here the OpenApi Json information generation service is added to the dependency injection container and is responsible for generating the corresponding OpenApi Json information according to the definition of the web api.
            services.AddSwaggerGen();
            services.AddControllersWithViews();
        }

 public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseExceptionHandler("/Home/Error");
            }
            app.UseStaticFiles();
            //UseSwagger adds a middleware that intercepts HTTP requests sent from browsers to get OpenApi Json information and returns WebApi description information to SwaggerUI. /localhost:5000/swagger/v1/swagger.json
            app.UseSwagger();
            
            //UseSwaggerUI adds a middleware which is mainly used to intercept SwaggerUI interface access requests and dynamically generate the interface list based on OpenApi Json information. In the above basic principle, the default http address for requesting SwaggerUI interface is: http://localhost:5000/ swagger/index.html
            app.UseSwaggerUI((options) =>
            {
                // The SwaggerEndPoint method is used to tell SwaggerUI which address to request to get the OpenApi Json information, we will explain how to customize this path later.
                options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
            });

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllerRoute(
                    name: "default",
                    pattern: "{controller=Home}/{action=Index}/{id?}");
            });
        }

app.UseSwaggerUI((options) =>
{
      //options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
      // Here tell SwaggerUI to get OpenApi Json information from /BogApis/v1/swagger.json.
        options.SwaggerEndpoint("/BlogApis/v1/swagger.json", "BlogApis");
});    

app.UseSwagger(swaggerOptions =>
{
       //Tell the OpenApi Json information request intercept middleware to return OpenApi Json information when it receives a request in the following format
       //Note: The path must contain: {documentName}, the Swagger middleware extracts the api document name from the {documentName} placeholder position in the request path in order to display the api information grouped under that document name. 
       // All api information under that document name.
       swaggerOptions.RouteTemplate = "/BlogApis/{documentName}/swagger.json";
});

  services.AddSwaggerGen(options =>
            {
                // here we will be the user-related API into a group, where the User is the name of the document (documentName)
                options.SwaggerDoc("User", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "User Management",
                    Version = "1.0"
                });
                // Here we split the article management related API into a group.
                options.SwaggerDoc("Post", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "Post Management",
                    Version = "1.0"
                });
                // The following is to set where to get the parameter comments, return values, etc. for all Web Api's in SwaggerUI.
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                options.IncludeXmlComments(xmlPath);
            });

 app.UseSwaggerUI((options) =>
            {
                //options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
                //options.SwaggerEndpoint("/BlogApis/v1/swagger.json", "BlogApis");

                // Define the path to request OpenApi Json information for user management related APIs.
                options.SwaggerEndpoint("/BlogApis/User/swagger.js
Add the [ApiExplorerSettings] feature to the UserController and PostController respectively, and set the group name
[Route("api/[controller]"), ApiExplorerSettings(GroupName = "User")]
    [ApiController]
    public class UserController : ControllerBase
    {
        /// <summary>
        /// User login
        /// </summary>
        /// <param name="userName">username</param>
        /// <param name="password">password</param>
        /// <returns></returns>
        [HttpPost]
        [ProducesResponseType(200, Type = typeof(UserInfo))]
        public UserInfo Login([FromForm] string userName, [FromForm] string password)
        {
            if (userName == "chenxin" && password == "123456")
            {
                return new UserInfo() { UserName = "chenxin", Age = 31 }
            }
            return null;
        }

        [HttpGet]
        public List<UserInfo> GetAllUsers()
        {
            return new List<UserInfo>()
            {
                new UserInfo()
                {
                    UserName="chenxin",
                    Age=31
                },
                new UserInfo()
                {
                    UserName="zhangsan",
                    Age=35
                }
            };
        }

 [Route("api/{controller}")]
    [ApiExplorerSettings(GroupName = "Post")]
    public class PostController : ControllerBase
    {
        /// <summary>
        /// Get all posts
        /// </summary>
        //// <returns></returns>
        [HttpGet]
        public List<Post> GetAllPosts()
        {
            return new List<Post> { new Post()
            {
                Title="Test Post",
                Content="Test content... "
            } };
        }
    }
    public class Post
    {
        public string Title { get; set; }
        public string Content { get; set; }
        public DateTime PublishTime { get; set; } = DateTime.Now;
    }

After following the above steps, we can see that the grouping of the API has been implemented.
Well, the question arises, why the default does not use the SwaggerDoc method to define any document name can also find the API information by default it, in fact, or Swagger middleware default to us to add a document named v1.
How do I customize the request path for SwaggerUI?
If you don't want to type swagger/index.html to access swaggerui, for example, you want to change it to /BlogApisDocs, open Startup.cs and find the Configure method and add the following code.

   app.UseSwaggerUI((options) =>
            {
                //options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
                //options.SwaggerEndpoint("/BlogApis/v1/swagger.json", "BlogApis");

                // Define the path to request OpenApi Json information for user management related APIs.
                options.SwaggerEndpoint("/BlogApis/User/swagger.json", "UserManagerApis");
                // Define the OpenApi Json information request path for the article management related API.
                options.SwaggerEndpoint("/BlogApis/User/swagger.json", "PostManagerApis");

                // Here we tell the SwaggerUI request interception middleware to return the SwaggerUI page when it receives a request for /BlogApisDocs from the browser.
                options.RoutePrefix = "BlogApisDocs";
            });

How to display API method comments, parameter comments automatically through SwaggerUI?
Open Startup.cs and find the ConfigureServices method and add the following code.
   services.AddSwaggerGen(options =>
            {
                // Here we split the user-related API into a group.
                options.SwaggerDoc("User", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "User Management",
                    Version = "1.0"
                });
                // Here we split the article management related API into a group.
                options.SwaggerDoc("Post", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "Post Management",
                    Version = "1.0"
                });
                //The following is to set where to get the parameter comments, return values, etc. of all Web Api in SwaggerUI.
                // Here it means go to read the annotation information of the API from the specified XML configuration file in the root of the site.
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                options.IncludeXmlComments(xmlPath);
            });

Then you need to set the WebApi project to automatically generate the XML file describing the API information when generating the project, and you need to set the generated XML configuration file SwaggerDemo.xml to always copy to the output directory at
This article mainly explains how to group APIs, and here is just an example of grouping by API function.
If you have any questions while reading this article, feel free to give me a call on my personal blog at
http://www.lovecoding.com.cn
 I will reply promptly when I see it!
This article about asp.net core integrated swagger ui is introduced to this, more related asp.net core integrated swagger ui content please search the script home previous articles or continue to browse the following related articles hope you will support the script home more in the future!

   services.AddSwaggerGen(options =>
            {
                // Here we split the user-related API into a group.
                options.SwaggerDoc("User", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "User Management",
                    Version = "1.0"
                });
                // Here we split the article management related API into a group.
                options.SwaggerDoc("Post", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "Post Management",
                    Version = "1.0"
                });
                //The following is to set where to get the parameter comments, return values, etc. of all Web Api in SwaggerUI.
                // Here it means go to read the annotation information of the API from the specified XML configuration file in the root of the site.
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                options.IncludeXmlComments(xmlPath);
            });