您的位置:首页 > 其它

swagger使用二:swagger配置多个项目注释

2017-02-09 16:12 706 查看
在项目中采用swagger测试接口,提供接口给其他人员都非常的方便.

在swagger默认配置中,默认只显示接口访问层中的注释,可是很多的参数说明都已经在实体层中了啊?(如下图)不可能再把实体层中的模型再搬过来吧,这样子重复性也太大了.



经过一番摸索,发现swagger可以同时支持多个路径的.

1.修改swagger的配置,添加多个文件路径.

    c.IncludeXmlComments(GetXmlControllersCommentsPath());
    c.IncludeXmlComments(GetXmlModelCommentsPath());


private static string GetXmlControllersCommentsPath()
{
return System.IO.Path.Combine(System.Web.HttpRuntime.AppDomainAppPath, "./App_Data/WebApi.XML");
}
private static string GetXmlModelCommentsPath()
{
return System.IO.Path.Combine(System.Web.HttpRuntime.AppDomainAppPath, "./App_Data/Model.XML");
}


2.修改实体层生成时,注释文档保存的位置,注意需要修改到接口访问层中的路径.



保存,重新生成,再访问swagger。



可以显示出实体层的注释了,完毕。
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: