.Net Core中使用Swagger

1、添加引用

nugget中搜索添加引用：Swashbuckle.AspNetCore

2、添加服務

public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            

            //使用swagger
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo() { Title = "CoreWebApi", Version = "v1", Description = "CoreWebApi_Description" });

                var basePath = AppDomain.CurrentDomain.BaseDirectory;
                foreach (var name in Directory.GetFiles(basePath, "*.xml", SearchOption.AllDirectories))
                {
                    c.IncludeXmlComments(name);
                }
            });
        }

 3、添加中間件

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
             
            app.UseSwagger();
            app.UseSwaggerUI(p =>
            {
                p.SwaggerEndpoint("/swagger/v1/swagger.json", "CoreWebApi V1");
            });

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
                
            }); 
        }

 

4、添加controller

[Route("api/[controller]")]
    [ApiController]
    public class UsersController : ControllerBase
    {
        SQLDbContext _dbContext;
        public UsersController(SQLDbContext dbContext)
        {
            _dbContext = dbContext;
        }
        /// <summary>
        /// 新增用戶
        /// </summary>
        /// <param name="userDTO"></param>
        /// <returns></returns>
        [Route("Add")]
　　　　　[HttpPost]
        public bool Add(UserDTO userDTO)
        {
            
        }
        /// <summary>
        /// 獲取用戶列表
        /// </summary>
        /// <param name="userQueryPatameters"></param>
        /// <returns></returns>
        [Route("List")]
　　　　　[HttpPost]
        public ReturnViewModel<UserViewModel> List(UserQueryPatameters userQueryPatameters)
        {
             
        }
    }

 

5、項目設置

項目右鍵，選擇屬性，勾選“XML文檔文件”，如下圖所示：

 

 

 注意增加“取消顯示警告”。

啓動程序訪問：https://localhost:5001/swagger/index.html