D_04 .net core 根据swagger动态生成接口文档

目的

(1)公司平台项目,无法向外提供swagger地址,需要提供在线文档;

(2)前后端对接存档;

(3)提高文档数据效率,保证文档不出错,正确性。

方案

对于.net core在线生成的方案很少,没有找到达到要求的功能实现,如通过razor生成html再转化,难以自定义开发及维护。因此决定自己开发在线生成文档。

1、构建样式模板文件;

2、程序读取样式模板文件,读取标题样式,读取样式表格;

3、传入目标swagger.json数据文件,在swagger业务F12中可以取到;

4、解析数据动态生成文件在线接口文档

结果图示

 

 

 

 生成的在线文档

 

接口代码编写规范

 

posted @ 2021-11-09 08:30  旭日阳光/hjw  阅读(148)  评论(0)    收藏  举报