找回密码
 立即注册
首页 业界区 业界 swagger文档生成html静态文档

swagger文档生成html静态文档

金娅鸣 前天 11:44
现在基于OpenApi开发的接口,可以生成swagger,开启swagger UI使用起来非常方便,由于需要对外开放接口,将swagger暴露还是不太方便,需要生成静态的html文档,可以让第三方对接的开发人员可以查看文档。
要生成静态的Html文档,swagger本身是不支持的,但是swagger提供了swagger.json文件,可以使用该文件配合来生成文档,方法如下:
一、使用redoc生成Html文档
  1、首先安装redoc,使用以下命令安装redoc
    npm install -g redoc-cli
  2、使用命令生成文档,使用以下命令,其中swagger.json就是swagger生成的Json文件,可以通过swagger导出该文件,并且将文件放在指定目录,命令执行成功后文档会放在与json文件所在的目录
  1. redoc-cli bundle swagger.json -o api-docs.html
复制代码
  3、使用redoc命令还是指定文档的标题、使用模板等功能,常用参数选项如下
参数说明示例-o输出文件名-o docs.html--title自定义标题--title "API 文档"--template自定义模板--template custom.hbs--options配置选项--options.menuToggle=true--cdn使用 CDN 资源--cdn  4、使用中遇到的问题,我是在win10中使用的redoc,使用命令成功安装了redoc工具,但是使用redoc-cli bundle swagger.json -o api-docs.html时报错,提示“不是内部命令也不是可执行文件或者批处理命令”,原因是权限不够,或者安装路径没有配置到系统环境变量中,解决办法配置环境变量或者使用以下命令即可:npx redoc-cli bundle openapi_swagger.json -o api-docs.html
二、使用NSwag,我是使用的上面的方法,该方法没有尝试过记录一下,命令如下
  1. dotnet tool install -g NSwag.Console
  2. nswag swagger2tsclient /input:swagger.json /output:api-docs.html
复制代码
 
[code][/code]
来源:程序园用户自行投稿发布,如果侵权,请联系站长删除
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
您需要登录后才可以回帖 登录 | 立即注册