常州哪家网站建设公司专业,宿迁网站设计,动力无限网站效果好不好,广西三类人员考试网前言回顾之前的两篇Swagger做Api接口文档#xff0c;我们大体上学会了如何在net core3.1的项目基础上#xff0c;搭建一套自动生产API接口说明文档的框架。本来在Swagger的基础上#xff0c;前后端开发人员在开发生产期间#xff0c;可以借此进行更加便捷的沟通交流。可是总… 前言 回顾之前的两篇Swagger做Api接口文档我们大体上学会了如何在net core3.1的项目基础上搭建一套自动生产API接口说明文档的框架。 本来在Swagger的基础上前后端开发人员在开发生产期间可以借此进行更加便捷的沟通交流。可是总有些时候遇到一些难缠的又不讲道理偏偏觉得将Swagger文档地址丢给客户会不够正式死活要一份word文档。 可是这个时候如果接口数量上百个甚至更多一个一个手动输入word那将是一笔耗时的工作。但却有什么办法可以解决呢 对了利用Swagge生成的Json文件转换为word文档不就可以了吗思路 1. 获取Swagger接口文档的Json文件 2. 解析Json文件数据填充到Html的表格中 3.根据生成的html转work文档模板 文档模板URL/api/Movie/AddMovie请求方式Post参数名参数类型是否必填说明idQueryFalse影视IDNameQueryFalse电影名称TypeQueryFalse电影类型状态码说明200Success示例请求参数返回值开始一、根据Swagger版本获取Json数据1.通过Swagger源码文件可以看到 可以拿到swagger生成的文档数据所以我们可以新建一个控制器SwaggerController.cs, 2. 在Startup.cs文件中利用net core的ioc容器注入SwaggerGenerator实例化这样在后面的调用中可以直接使用这个方法 services.AddScopedSwaggerGenerator(); //注入SwaggerGenerator,后面可以直接使用这个方法二、文件数据填充到Html的表格中根据上面获取的model文件数据这个时候我们利用Razor文件结合html的table模板将数据遍历填充到页面中生成完整的页面Html模板将数据遍历到静态页面中三、根据生成的html转work文档 四、最终效果将html转换为word后我们就可以看到带有 .doc 的效果了差不多是如下效果总结 1. 到这基本就结束了通过简易的几个接口的方式展示了如何通过将Swagger接口文档生成word文档。可以根据自己的html模板生成各式的word样式文档说明。 2.写这篇番外主要是因为之前介绍了关于如何使用Swagger生成在线文档但实际工作中可能也会遇到这种要各种正式word文档的客户所以在此分享一些想法和思路同时希望大家不吝指教。 3.后续还会不断修改和完善可以更多的生成不同的文件类型和按需生成不同版本的接口文档持续更新。。。 4 .注搜索关注公众号【DotNet技术谷】--回复【文档生成器】可获取本篇Swagger转换work文件 5. 参考资料Spire.Doc文件 、Swagger开源地址
