自由、创新、研究、探索
Linux/Windows Mono/DotNet [ Open Source .NET Development/ 使用开源工具进行DotNet软件开发]锐意进取，志存高远.成就梦想，只争朝夕.从你开始，创新世界.【That I exist is a perpetual supprise which is life. Focus on eCommerce】
　　你需要为客户编写Api调用手册？你需要测试你的Api接口？你需要和前端进行接口对接？那么这篇文章应该可以帮到你。本文将介绍创建Web Api 帮助文档页面的两种方式，Microsoft Help Page和Swashbuckle Help Page。
编写RESTful的Web Api
&View Code
Microsoft&Help Page
1.在Nuget添加Help Page组件。
　　组件添加完后，会自动生成帮助页面，文件存在区域（Areas）中
2.注册区域（Areas）
　　在Global.asax文件中的Application_Start()方法添加以下代码：
　　AreaRegistration.RegisterAllAreas();
　　浏览生成的帮助页面：http://localhost:xxxx/help
　　Web API的方法列表已经显示出来了，但是方法的描述还是默认的描述。
3. 修改配置文件生成位置　　右键项目属性，指定输出xml。
　　修改Areas\HelpPage\App_Start\HelpPageConfig.cs中register方法里指定的xml路径为上述指定输出的路径。
　　再查看帮助页面，方法描述已经和代码注释一致。
　　注：这里可根据需要把Area中对应页面的英文词条更新成中文，当然样式也可以调整。
4.添加测试工具
　　在Nuget添加Test Client组件。
　　在Areas\HelpPage\Views\Help\Api.cshtml添加以下代码：
　　@Html.DisplayForModel("TestClientDialogs")
　　@section Scripts {
& & 　　&link type="text/css" href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" /&
& & 　　@Html.DisplayForModel("TestClientReferences")
　　再次运行Help Page，每个API说明页面的右下角会多一个测试的按钮。
Swashbuckle&Help Page
1.在Nuget添加Swashbuckle组件。
　　然后就可以浏览生成的帮助页面：http://localhost:xxxx/swagger
　　Web API的方法列表已经显示出来了，但是方法的描述还没有显示出来。
2. 修改配置文件生成位置　　右键项目属性，指定输出xml。
　　找到SwaggerConfig.cs
　　把&c.IncludeXmlComments(GetXmlCommentsPath())的注释去掉
　　实现GetXmlCommentsPath()方法，指定xml路径为上述指定输出的路径。
　　再查看帮助页面，方法描述已经和代码注释一致。
2. 常见异常
　　用Nuget引用dll的时候，它会在config中添加依赖项信息，但偶尔会没添加，这时会出现Could not load file or assembly 'XXX' or one of its dependencies. The located assembly's manifest definition does not match the assembly reference. (Exception from HRESULT: 0x)异常。
　　此时只要在config中添加对应的依赖项就好
4.帮助页面词条及样式调整
　　如果要修改或编辑Swashbuckle Help Page的样式或词条，需要编辑SwaggerConfig.cs，相对Microsoft&Help Page可能要复杂一点（我只改过Microsoft的，没改过Swashbuckle的）。具体如何修改可参考：
　　Swashbuckle&Help Page搭建起来相对会比较简单，但是样式（自带swagger logo）和词条修改会较麻烦一点，因此，比较适合作为内部接口说明几接口调用测试。
　　Microsoft&Help Page搭建起来相对要麻烦一点点，但是样式和词条修改会方便一点，因此，比较适合作为外部接口调用使用文档。
阅读(...) 评论()
随笔 - 15982
评论 - 1342Access denied |
used Cloudflare to restrict access
Please enable cookies.
What happened?
The owner of this website () has banned your access based on your browser's signature (384e55eb71870d73-ua98).您所在位置： &
&nbsp&&nbsp&nbsp&&nbsp
搜狗皇冠样式使用手册.pdf16页
本文档一共被下载：
次 ,您可全文免费在线阅读后下载本文档。
文档加载中...广告还剩秒
需要金币：80 &&
你可能关注的文档：
··········
··········
搜索策略产品组 皇冠样式使用手册
一、在哪里投放和管理皇冠？
二、如何投放和管理皇冠？ 皇冠物料的基本操作包括：皇冠物料的查看、新增、批量新增、修改、删除、 复制、暂停/取消暂停。 可以在旭日后台直接管理，也可以利用批量工具进行管理。 1 搜索策略产品组
1、皇冠物料的查看：
2、皇冠物料的新增： 第一步：点击 “新建附加创意”： 第二步：选择希望添加皇冠物料的推广计划、推广组、投放设备，填写文字
子链（必填）、图片（选填），完成后点击“确认”： 2 搜索策略产品组
选推广组 选设备 看预览 写子链 加图片 3、皇冠物料的批量新增： 第一步：批量新建附加创意： 3 搜索策略产品组
第二步：从左侧的账户推广组结构树中，找到希望创建皇冠物料的推广组，
并逐个点击“添加”：
第三步：填写附加创意。完成后，点击“确认”。 4 搜索策略产品组
4、皇冠物料的修改 ： 第一步：勾选需要修改的皇冠物料，并点击“修改”： 第二步：修改皇冠物料，完成后，点击“确认”： 5 搜索策略产品组
5、皇冠物料的删除： 勾选希望删除的皇冠物料，并点击“删除”： 6 搜索策略产品组
6、皇冠物料的复制： 第一步：勾选希望复制的皇冠物料，并点击“复制”： 第二步：从左侧的账户推广组结构树中，找到希望复制到的目的推广组，并
逐个点击“添加”： 7 搜索策略产品组
第三步：确定皇冠物料和推广组之后，点击“确定”： 8 搜索策略产品组
7、皇冠物料的暂停/取消暂停： 勾选希望操作的皇冠物料，并点击“暂停/取消暂停”： 9 搜索策略产品组
8、批量工具 ： 由于批量工具模板有更新，请下载系统提供的最新模板，否则无法上传。
正在加载中，请稍后...PAPERPORT用户手册_百度文库
两大类热门资源免费畅读
续费一年阅读会员，立省24元！
PAPERPORT用户手册
上传于|0|0|文档简介
&&PAPERPORT用户手册
阅读已结束，如果下载本文需要使用2下载券
想免费下载本文？
定制HR最喜欢的简历
下载文档到电脑，查找使用更方便
还剩32页未读，继续阅读
定制HR最喜欢的简历
你可能喜欢}