本次笔记为实际项目初期开发的记录,对于swagger的运用网上已经有很多的文章了,这里不会详写,只给个大概步骤,会写一些在项目开发中的坑以及处理办法。
(1)安装swagger
1. 在nuget管理器中安装最新版 Swashbuckle.AspNetCore 的包。
2.在api项目的 属性 -- 生成 中勾选XML文档文件,路径到时候要能匹配startup中的配置。
3.在startup中注册服务并配置中间件
到这里我的swagger就经过本地发布测试就能跑起来了,关键在于实际运行,以下是实际环境的坑。
(1)我项目运行的正式环境受限于现有服务器环境以及个人技术原因,选择了windows server2012 r2(或2008 r2) + IIS,并且是作为80站点下的一个子程序发布的,
发布后访问swagger,会报如下错误
但是当我访问swagger.json,是可以找到json文件的。
于是我查看控制台的network,发现了一些不对劲的地方,原本应该是以https + 域名 + 子程序名 + swagger配置路径,但是情况却如下所示
访问json的路径是错误的,应该修正的点有http协议和json文件路径,于是从starup入手做出如下修改
重新发布运行。
发布成功!