最新版flash player,东城卫修,楼台成海气下一句
目前市场上主流的开发模式,几乎清一色的前后端分离方式,作为服务端开发人员,我们有义务提供给各个客户端良好的开发文档,以方便对接,减少沟通时间,提高开发效率;对于开发人员来说,编写接口文档需要消耗大量的时间,并且,手动编写的文档接口会由于需求的频繁变动变得难以维护,这就需要一个在接口开发阶段可以自动监测接口输入参数,自动生成文档的功能;由于 swagger 插件的出现,这项工作几乎可以实现完全的自动化。
swagger 是由 smartbear 公司开发的一款 api 文档自动化工具,其采用 apache 2.0 免费开源授权协议,允许任何人免费使用该工具,利用 swagger 的特性,可以很方便在没有任何实现逻辑的情况下生成可视化和与api资源交互界面,swagger 支持 api 分类导航,提供 api 测试套件,完全的可定制化,对开发人员和 api 消费者都非常友好。
swashbuckle.aspnetcore swashbuckle.aspnetcore.annotations
static string[] docs = new[] { "未分类" }; public void configureservices(iservicecollection services) { services.addmvc().setcompatibilityversion(compatibilityversion.version_2_1); if (env.isdevelopment()) { services.addswaggergen(options => { foreach (var doc in docs) options.swaggerdoc(doc, new info { version = doc }); options.docinclusionpredicate((docname, description) => { description.trygetmethodinfo(out methodinfo mi); var attr = mi.declaringtype.getcustomattribute<apiexplorersettingsattribute>(); if (attr != null) { return attr.groupname == docname; } else { return docname == "未分类"; } }); options.customschemaids(d => d.fullname); options.includexmlcomments("ron.swaggertest.xml", true); }); } } // this method gets called by the runtime. use this method to configure the http request pipeline. public void configure(iapplicationbuilder app, ihostingenvironment env) { if (env.isdevelopment()) { app.usedeveloperexceptionpage(); app.useswagger() .useswaggerui(options => { options.documenttitle = "ron.liang swagger 测试文档"; foreach (var item in docs) options.swaggerendpoint($"/swagger/{item}/swagger.json", item); }); } app.usemvc(); } }
http://localhost:5000/swagger/
上面是默认的 api 文档,在实际开发中,肯定需要对 api 进行分组和完善输出参数给消费者,现在就来对 controller 进行改进,首先是设置分组名称
[route("api/[controller]"), apiexplorersettings(groupname = "演示分组")] [apicontroller] public class valuescontroller : controllerbase
static string[] docs = new[] { "未分类", "演示分组" };
/// <summary> /// 获取数组 /// </summary> /// <remarks> /// <code> /// 输出参数:["value1", "value2"] /// </code> /// </remarks> /// <returns></returns> [httpget] public actionresult<ienumerable<string>> get() { return new string[] { "value1", "value2" }; }
https://files.cnblogs.com/files/viter/ron.swaggertest.zip
如对本文有疑问,请在下面进行留言讨论,广大热心网友会与你互动!! 点击进行留言回复
asp.net搭建博客,使用BlogEngine.NET+MySql搭建博客
网友评论