241  
查询码:00000335
将Swagger接口文档导出成Word文档
作者: 俞鹏 于 2022年01月04日 发布在分类 / 人防组 / 人防后端 下,并于 2022年01月04日 编辑
Swagger

1.Swagger是什么?它能干什么?

相信无论是前端还是后端开发,都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力,经常来不及更新。其实无论是前端调用后端,还是后端调用后端,都期望有一个好的接口文档。但是这个接口文档对于程序员来说,就跟注释一样,经常会抱怨别人写的代码没有写注释,然而自己写起代码起来,最讨厌的,也是写注释。所以仅仅只通过强制来规范大家是不够的,随着时间推移,版本迭代,接口文档往往很容易就跟不上代码了。


发现了痛点就要去找解决方案。解决方案用的人多了,就成了标准的规范,这就是Swagger的由来。通过这套规范,你只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger衍生出来的一系列项目和工具,就可以做到生成各种格式的接口文档,生成多种语言的客户端和服务端的代码,以及在线接口调试页面等等。这样,如果按照新的开发模式,在开发新版本或者迭代版本的时候,只需要更新Swagger描述文件,就可以自动生成接口文档和客户端服务端代码,做到调用端代码、服务端代码以及接口文档的一致性。

2.导出Word文档

上面提到了Swagger的好处,虽然后端不需要花费时间和精力去编写及维护接口文档,但是往往在项目验收的时候,需要提交给客户很多的文档,其中就包括接口文档,所以,这里就需要将Swagger文档导出成Word文档,来满足项目验收的需要。


2.1.json文件

JSON包含路径信息和http请求动词,是符合OpenAPI规范的OpenAPI文档。如下图:

粘贴图片


2.2.接口实现

相关功能已经做成一个接口,集成到了管理中心,部分代码如下图:

粘贴图片


2.3.使用Razor视图引擎渲染视图为字符串

在项目需求上需要根据模板生产静态页面,那么可以用Razor语法去直接解析你的页面从而把解析的页面生成静态页,这样的使用场景很多,不限于生成静态页面,视图引擎为我们提供了模型到视图的代码或文本生成的能力。
粘贴图片

粘贴图片


注:具体代码可以去管理中心查看,如发现问题或有优化建议,欢迎交流~~



 推荐知识

 历史版本

修改日期 修改人 备注
2022-01-04 14:30:58[当前版本] 俞鹏 V1.0

 附件

附件类型

PNGPNG

知识分享平台 -V 4.8.7 -wcp