Asp.Net Boilerplate Project 使用swagger调试api

文件有点大，去掉了packages文件夹，(Swashbuckle.Core.5.6.0)

链接：https://pan.baidu.com/s/1DzMLhFyRav0dufS4dTeMzg
提取码：lab0

在https://aspnetboilerplate.com/Templates下载模板

在项目SimpleTaskSystem.WebApi里安装Swashbuckle.core 5.6.0

安装成功后再文件SimpleTaskSystemWebApiModule.cs的方法Initialize里调用ConfigureSwaggerUi();

 private void ConfigureSwaggerUi()
 {
     Configuration.Modules.AbpWebApi().HttpConfiguration
         .EnableSwagger(c =>
         {
             c.SingleApiVersion("v1", "SimpleTaskSystem.WebApi");
             c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
         })
         .EnableSwaggerUi(c =>
         {
             //路径规则，项目命名空间.文件夹名称.js文件名称
             c.InjectJavaScript(Assembly.GetAssembly(typeof(SimpleTaskSystemWebApiModule)), "SimpleTaskSystem.Api.Scripts.Swagger.js");
             //汉化
             //c.InjectJavaScript(Assembly.GetExecutingAssembly(), "SimpleTaskSystem.Api.Scripts.Translator.js");
             c.InjectJavaScript(Assembly.GetAssembly(typeof(SimpleTaskSystemWebApiModule)), "SimpleTaskSystem.Api.Scripts.Translator.js");
         });
 }

然后再api文件夹下创建新的文件夹Scripts，再Scripts里创建js文件Swagger.js。

 var getCookieValue = function(key) {
     var equalities = document.cookie.split('; ');
     for (var i = 0; i < equalities.length; i++) {
         if (!equalities[i]) {
             continue;
         }

         var splitted = equalities[i].split('=');
         if (splitted.length !== 2) {
             continue;
         }

         if (decodeURIComponent(splitted[0]) === key) {
             return decodeURIComponent(splitted[1] || '');
         }
     }

     return null;
 };

 var csrfCookie = getCookieValue("XSRF-TOKEN");
 var csrfCookieAuth = new SwaggerClient.ApiKeyAuthorization("X-XSRF-TOKEN", csrfCookie, "header");
 swaggerUi.api.clientAuthorizations.add("X-XSRF-TOKEN", csrfCookieAuth);

汉化的js：

 '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": "响应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();
 });

需要注意的是：着两个文件的“生成操作”必须的“嵌入的资源”，否则在访问http://localhost:6234/swagger/ui/index时，会报这两个js文件加载失败。

编译解决方案后我们就可以运行看看是否有误了：

http://localhost:6234/swagger/ui/index

打开F12，我们看到已经正确加载了

接下来，我们测试一下

打开http://localhost:6234/swagger，我们可以看到下图的api列表：

其中 app_author、app_book、app_category是我们创建的

下面我们测试下app_author的api，首先插入一条数据：

可以看到已经成功，然后我们看下所有数据：

我们再看下根据id获取数据

我们更新一个数据试试：

删除一条呢：

我们可以看到Author的这几个api都是可以的。

提示：在新增book时，由于表的关联关系，只有在正确输入Category和Author的id后才能创建成功。