基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

前言

回顾之前的两篇 Swagger Api 接口文档 ,我们大体上学会了如何在 net core3.1 的项目基础上,搭建一套自动生产 API 接口说明文档的框架。

本来在 Swagger 的基础上,前后端开发人员在开发生产期间,可以借此进行更加便捷的沟通交流。可是总有些时候,遇到一些难缠的,又不讲道理,偏偏觉得将 Swagger 文档地址丢给客户会不够正式!死活要一份 word 文档。  

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

可是这个时候,如果接口数量上百个,甚至更多,一个一个手动输入 word ,那将是一笔耗时的工作。但却有什么办法可以解决呢?   

对了,利用 Swagge 生成的 Json 文件转换为 word 文档不就可以了吗?

思路

1.  获取 Swagger 接口文档的 Json 文件

2.  解析 Json 文件数据填充到 Html 的表格中

3. 根据生成的 html work 文档

模板

    文档模板

URL

/api/Movie/AddMovie

请求方式

Post

参数

参数类型

是否必填

说明

id

Query

False

影视ID

Name

Query

False

电影名称

Type

Query

False

电影类型

状态码

说明

200

Success

示例

请求参数

返回值

开始

一、根据Swagger版本获取Json数据

1. 通过 Swagger 源码文件可以看到

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

可以拿到 swagger 生成的文档数据,所以我们可以新建一个控制器 SwaggerController.cs,      

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

2.  Startup.cs 文件中,利用 net core ioc 容器,注入 SwaggerGenerator 实例化,这样在后面的调用中可以直接使用这个方法

services.AddScoped<SwaggerGenerator>();  // 注入SwaggerGenerator,后面可以直接使用这个方法

二、文件数据填充到Html的表格中

根据上面获取的 model 文件数据,这个时候,我们利用 Razor 文件,结合 html table 模板,将数据遍历填充到页面中,生成完整的页面

Html 模板

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

将数据遍历到静态页面中,

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

三、根据生成的html转work文档     

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

四、最终效果

html 转换为 word 后,我们就可以看到带有  .doc  的效果了!差不多是如下效果

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

总结

1.  到这基本就结束了,通过简易的几个接口的方式,展示了如何通过将 Swagger 接口文档生成 word 文档。可以根据自己的 html 模板生成各式的 word 样式文档说明。

2. 写这篇番外主要是因为之前介绍了关于如何使用 Swagger 生成在线文档,但实际工作中,可能也会遇到这种要各种正式 word 文档的客户,所以在此分享一些想法和思路,同时希望大家不吝指教。

3. 后续还会不断修改和完善,可以更多的生成不同的文件类型和按需生成不同版本的接口文档, 持续更新。。。

4 . 注:搜索关注公众号【 DotNet 技术谷】 回复【文档生成器】,可获取本篇 Swagger 转换 work 文件

5.  参考资料: Spire.Doc 文件   Swagger 开源地址

基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

原文 

http://mp.weixin.qq.com/s?__biz=MzAwNTMxMzg1MA==&mid=2654079133&idx=5&sn=35dffe808e850002019e283666c36e1f

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » 基于.NetCore3.1搭建项目系列 —— 使用Swagger导出文档 (番外篇)

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址