Api文档生成工具DocFx

 前提：说起Api的接口文档，除了开发和测试常用的Swagger，出于安全和公开性，使用DocFX生成帮助文档

生成的文档效果如下图：

可以添加Markdown风格的笔记，展示API接口的文档，会显示接口详细的参数以及返回类型

 

 

 

.Net Core Swagger 参考地址： https://www.cnblogs.com/ywkcode/p/11498586.html

 

下面介绍DocFX的使用

DOCFX官网： https://dotnet.github.io/docfx/

1.选择最新版本的DocFX版本，DocFX是一款开源的文档生成工具

 

 如果下载过慢，分享网盘链接：

链接：https://pan.baidu.com/s/1CobbyIgAnCKjJnO6-Kc0kg   提取码：q3c7

 

 

2.设置环境变量

解压docfx.zip文件，在所在文件夹目录下输入进入命令行

执行 docfx help,如下图所示：

 

 

要想在全局使用命令docFX,需要配置计算机的环境变量

右击“我的电脑”-》属性-》“高级系统设置”-》“环境变量”-》“系统变量”-》“Path”-》添加DocFX.exe 所在路径

 

 

 配置完成后，即可在任意地方使用命令 DOCFX

 

3.初始化DocFX项目目录

（1）执行 docfx init -q

 

 

（2）生成一个docfx开头的项目文件

 

（3）执行 docfx  docfx.json生成文档网站

（4）多了_site文件夹

（5）执行docfx serve _site 生成文档网站

可以直接访问8080端口，也可以将_site中的文件直接在IIS中发布

 

4.添加项目文件，生成项目接口文档

把项目的.csproj结尾的项目文件以及接口层，或者实体层文件，拷贝至“src”文件夹中

执行 docfx  docfx.json生成文档网站，把_site文件夹部署到IIS即可

 

5.把文档生成PDF

 推荐工具 WkHtmlToPdf，使用方法参考我的博客中《利用WkHtmlToPdf，把H5 转成PDF》

https://www.cnblogs.com/ywkcode/p/10886393.html

 

以上，仅供学习和总结