Swagger实例分享(VS+WebApi+Swashbuckle)

Swagger实例分享(VS+WebApi+Swashbuckle)

　　Swagger可以很方便的为发布的WebApi自动生成优雅的文档，不需额外自己编写，只需为项目配置好，是一个很好用的工具，做一个简单的Demo和大家分享一下~

1、使用HuGet导入Swashbuckle包

2、修改SwaggerConfig.cs

　　导入Swashbuckle后会自动在站点的App_Start文件夹下生成SwaggerConfig.cs，用于配置Swagger页面。配置的东西很多，下面只列举我个人需要的简单的配置（因为其他没研究）。

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

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {                      
                        c.SingleApiVersion("v1", "MyWebApi").Contact(x =>
                        {
                            x.Name("Bobbie");　　//配置界面头部描述
                        });

                        c.IncludeXmlComments(GetXmlCommentsPath("/bin/WarRoom.WebApi.XML"));　　//配置模板XML路径
                        
                    })
                .EnableSwaggerUi(c =>
                    {      
　　　　　　　　　　　　　　　　　　c.InjectJavaScript(Assembly.GetExecutingAssembly(), "MyWebApi.Scripts.Swagger_CN.js");　　//配置汉化js文件
                    });
        }

        private static string GetXmlCommentsPath(string XmlPath)
        {
            return $@"{System.AppDomain.CurrentDomain.BaseDirectory}" + XmlPath;
        }
    }

3、配置项目属性

主要是设置“生成”下的几个配置，就是我画红框框的，下面解释一下几个配置的作用：

(1)禁止警告1591是属于禁止缺少注释的警告的，不然没有头部注释的类、函数都会有警告的下划线，看着不舒服（但该警告不影响使用）。

(2)勾选XML文档文件，会自动生成一个路径，这个路径要于SwaggerConfig.cs中配置的一致：

c.IncludeXmlComments(GetXmlCommentsPath("/bin/WarRoom.WebApi.XML"));

由此其实已经配置完成，下面进行测试：

4、测试

　　新建一个Controller，文件名为DemoController.cs：

public class DemoController : ApiController
    {
        /// <summary>
        /// 我就是PostTest方法
        /// </summary>
        /// <param name="name">参数1</param>
        /// <returns></returns>
        [HttpGet]
        public string PostTest(string name)
        {
            string result = "Hello " + name;           
            return result;
        }

　　然后运行，访问localhost:27827/Swagger(网址端口看自己的项目)，可以看到如下界面就是成功了：

　　页面会将接口路径、接口函数、注释、参数等基本信息都自动生成，还提供接口测试功能(单击Try it Out)，可以测试接口(可直接输入参数)。

5、汉化

　　有些朋友喜欢中文，这边也测试一下汉化的功能，主要就是添加一个汉化功能的JS文件，并在SwaggerConfig.cs配置导入即可：

（1）新建名为Swagger_CN.js的文件，放在Scripts文件夹下：

'use strict';  
/** 
 * Translator for documentation pages. 
 * 
 * To enable translation you should include one of language-files in your index.html 
 * after <script src='lang/translator.js' type='text/javascript'></script>. 
 * For example - <script src='lang/ru.js' type='text/javascript'></script> 
 * 
 * If you wish to translate some new texsts you should do two things: 
 * 1. Add a new phrase pair ("New Phrase": "New Translation") into your language file (for example lang/ru.js). It will be great if you add it in other language files too. 
 * 2. Mark that text it templates this way <anyHtmlTag data-sw-translate>New Phrase</anyHtmlTag> or <anyHtmlTag data-sw-translate value='New Phrase'/>. 
 * The main thing here is attribute data-sw-translate. Only inner html, title-attribute and value-attribute are going to translate. 
 * 
 */  
window.SwaggerTranslator = {  
    _words: [],  
    translate: function () {  
        var $this = this;  
        $('[data-sw-translate]').each(function () {  
            $(this).html($this._tryTranslate($(this).html()));  
            $(this).val($this._tryTranslate($(this).val()));  
            $(this).attr('title', $this._tryTranslate($(this).attr('title')));  
        });  
    },  
    _tryTranslate: function (word) {  
        return this._words[$.trim(word)] !== undefined ? this._words[$.trim(word)] : word;  
    },  
    learn: function (wordsMap) {  
        this._words = wordsMap;  
    }  
}; 
/* jshint quotmark: double */  
window.SwaggerTranslator.learn({  
    "Warning: Deprecated": "警告：已过时",  
    "Implementation Notes": "实现备注",  
    "Response Class": "响应类",  
    "Status": "状态",  
    "Parameters": "参数",  
    "Parameter": "参数",  
    "Value": "值",  
    "Description": "描述",  
    "Parameter Type": "参数类型",  
    "Data Type": "数据类型",  
    "Response Messages": "响应消息",  
    "HTTP Status Code": "HTTP状态码",  
    "Reason": "原因",  
    "Response Model": "响应模型",  
    "Request URL": "请求URL",  
    "Response Body": "响应体",  
    "Response Code": "响应码",  
    "Response Headers": "响应头",  
    "Hide Response": "隐藏响应",  
    "Headers": "头",  
    "Try it out!": "试一下！",  
    "Show/Hide": "显示/隐藏",  
    "List Operations": "显示操作",  
    "Expand Operations": "展开操作",  
    "Raw": "原始",  
    "can't parse JSON.  Raw result": "无法解析JSON. 原始结果",  
    "Model Schema": "模型架构",  
    "Model": "模型",  
    "apply": "应用",  
    "Username": "用户名",  
    "Password": "密码",  
    "Terms of service": "服务条款",  
    "Created by": "创建者",  
    "See more at": "查看更多：",  
    "Contact the developer": "联系开发者",  
    "api version": "api版本",  
    "Response Content Type": "响应内容类型",  
    "fetching resource": "正在获取资源",  
    "fetching resource list": "正在获取资源列表",  
    "Explore": "浏览",  
    "Show Swagger Petstore Example Apis": "显示 Swagger Petstore 示例 Apis",  
    "Can't read from server.  It may not have the appropriate access-control-origin settings.": "无法从服务器读取。可能没有正确设置access-control-origin。",  
    "Please specify the protocol for": "请指定协议：",  
    "Can't read swagger JSON from": "无法读取swagger JSON于",  
    "Finished Loading Resource Information. Rendering Swagger UI": "已加载资源信息。正在渲染Swagger UI",  
    "Unable to read api": "无法读取api",  
    "from path": "从路径",  
    "server returned": "服务器返回"  
});  
$(function () {  
    window.SwaggerTranslator.translate();  
});  

（2）将Swagger_CN.js设置为“嵌入的资源”

属性->生成操作->设置为“嵌入的资源”

（3）配置SwaggerConfig.cs

在EnableSwaggerUi下添加：

c.InjectJavaScript(Assembly.GetExecutingAssembly(), "MyWebApi.Scripts.Swagger_CN.js");　　
注：MyWebApi.Scripts.Swagger_CN.js格式为：项目名.文件夹名.JS文件名

这个可以看上面的SwaggerConfig.cs文件配置。然后再次运行：

　　现在就可以看到你日思夜想的中文了~