webapi使用swagger自动生成说明文档和测试用例

最新推荐文章于 2024-08-05 16:35:39 发布

跟我聊天我会闯红灯

最新推荐文章于 2024-08-05 16:35:39 发布

阅读量354

点赞数

分类专栏：工具使用文章标签： visual studio

原文链接：https://www.cnblogs.com/webapi/p/10537859.html

版权

工具使用专栏收录该内容

6 篇文章 0 订阅

订阅专栏

1、Nuget搜索swagger，然后安装Swashbuckle

2、生成api的xml文档

webapi项目右键——属性——生产——输出

设置Swagger

修改/App_Start/SwaggerConfig.cs，注意xml地

复制代码

using System.Web.Http;
using WebActivatorEx;
using cms.WebApi;
using Swashbuckle.Application;

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

namespace cms.WebApi
{
    public class SwaggerConfig
    {
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                {
                    c.SingleApiVersion("v1", "cms.WebApi");
                    c.IncludeXmlComments(string.Format("{0}/App_Data/cms.WebApi.XML", System.AppDomain.CurrentDomain.BaseDirectory));//设置xml地址
                })
                .EnableSwaggerUi(c =>
                {
                    c.DocumentTitle("My webapi");
                    c.InjectJavaScript(thisAssembly, "cms.WebApi.Scripts.Swagger.swagger_lang.js");//汉化js
                });
        }
    }
}