C# （WebApi）整合 Swagger

JagTom

已于 2024-02-23 15:25:21 修改

阅读量3.8k

点赞数 17

CC 4.0 BY-SA版权

文章标签： c# webapi Swagger

于 2024-02-23 14:58:05 首次发布

本文链接：https://blog.csdn.net/m0_46845579/article/details/136256067

SpringBoot-整合Swagger_jboot整合swagger-CSDN博客

C# webapi 也可以整合Swagger

webapi运行其实有个自带的HELP页面

但是如果觉得UI不好看，且没办法显示方法注释等不方便的操作，我们也可以整合Swagger

一、使用NuGet控制台安装Swagger

在菜单中选择工具->NuGet包管理器->程序包管理器控制台输入指令

Install-Package Swashbuckle

安装成功就已经可以访问页面了

直接运行项目:IP地址:端口号+swagger/ui/index 即可浏览成功。但是会发现页面是英文的且注释无法显示。

二、配置Swagger 显示中文且显示注释

安装完Swagger会在App_Start文件夹下自动生成 SwaggerConfig.cs 更新它

using System.Web.Http;
using WebActivatorEx;
using TPGYWebAPI;
using Swashbuckle.Application;
using TPGYWebAPI.App_Start;
using System.Linq;
using System.Reflection;

[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]

namespace TPGYWebAPI
{
public class SwaggerConfig
{
    public static void Register()
    {
        var thisAssembly = typeof(SwaggerConfig).Assembly;
 
        GlobalConfiguration.Configuration
            .EnableSwagger(c =>
                {
                    c.SingleApiVersion("v1", "TPGYWebAPI");
                    //添加下述代码   
                    //注意这里的xml文件名要改成你自己的!!!!                     
                    var xmlFile = string.Format("{0}/bin/TPGYWebAPI.XML", System.AppDomain.CurrentDomain.BaseDirectory);
                    if (System.IO.File.Exists(xmlFile))
                    {
                        c.IncludeXmlComments(xmlFile);
                    }
                    c.ResolveConfli