swagger文档生成html静态文档
现在基于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文件所在的目录
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,我是使用的上面的方法,该方法没有尝试过记录一下,命令如下
dotnet tool install -g NSwag.Console
nswag swagger2tsclient /input:swagger.json /output:api-docs.html
swagger文档生成html静态文档的更多相关文章
- Swagger+Spring mvc生成Restful接口文档
简介 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集 ...
- Swagger接口如何生成Html离线文档
A very simple tool that converts Swagger Api Document to Html File. 小记Swagger接口生成Html离线文档 由来 很多人用swa ...
- Spring Boot 2.x基础教程:Swagger静态文档的生成
前言 通过之前的两篇关于Swagger入门以及具体使用细节的介绍之后,我们已经能够轻松地为Spring MVC的Web项目自动构建出API文档了.如果您还不熟悉这块,可以先阅读: Spring Boo ...
- 使用Swagger2Markup归档swagger生成的API文档
文章出处: http://blog.didispace.com/swagger2markup-asciidoc/ 说明 项目中使用Swagger之后,我们能够很轻松的管理API文档,并非常简单的模拟接 ...
- SpringBoot2中,怎么生成静态文档
SpringBoot2中,怎么生成静态文档 在实际开发过程中,我们通过swagger就可以生成我们的接口文档,这个文档就可以提供给前端人员开发使用的.但是,有时候,我们需要把我们的接口文档,提供给第三 ...
- 使用swagger作为restful api的doc文档生成
初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情.也许多点,也许少点.甚至,接口总是需要适应新需求的,修改了,增加了,这份 ...
- SpringBoot18 Swagger、API接口文档生成、WireMock、模拟后台数据
1 Swagger 1.1 简述 前后端分离的项目需要前后端开发人员协同工作,后台开发人员需要给到前端开发者一套API文档:利用Swagger可以简单高效的帮助后台开发者生成RestfulAPI开发文 ...
- Spring Boot 集成 Swagger 生成 RESTful API 文档
原文链接: Spring Boot 集成 Swagger 生成 RESTful API 文档 简介 Swagger 官网是这么描述它的:The Best APIs are Built with Swa ...
- 求你别再用swagger了,给你推荐几个在线文档生成神器
前言 最近公司打算做一个openapi开放平台,让我找一款好用的在线文档生成工具,具体要求如下: 必须是开源的 能够实时生成在线文档 支持全文搜索 支持在线调试功能 界面优美 说实话,这个需求看起来简 ...
- NET 5.0 Swagger API 自动生成MarkDown文档
目录 1.SwaggerDoc引用 主要接口 接口实现 2.Startup配置 注册SwaggerDoc服务 注册Swagger服务 引用Swagger中间件 3.生成MarkDown 4.生成示例 ...
随机推荐
- CUDA 线程ID 计算方式
thread ID 的计算方式,简单来说很像小学学的除法公式,本文转载自同学一篇博客:并进行简单修改: 被除数 = 除数 * 商 + 余数 用公式表示:$$线程Id = blockId * block ...
- 操作系统:CPU工作模式-- 执行程序的三种模式
按照 CPU 功能升级迭代的顺序,CPU 的工作模式有实模式.保护模式.长模式,这几种工作模式下 CPU 执行程序的方式截然不同,下面我们一起来探讨这几种工作模式. 从一段死循环的代码说起 int m ...
- DOS命令——带包的类的编译与运行
手动版:a.javac编译当前类文件 b.手动建立与包名对应的文件夹 c.把a步骤中编译出的.class 文件放到b步骤中的最底层文件夹下 ...
- POWERBI_创建工作区应用_协同办公能力 up up up
在powerbi中,我们往往会创建很多不同模型的报表,他们分别独立,但是在业务决策过程中,我们需要跨报表查看数据,反复切换报表,低效且忙乱 这个时候,合并展示报表是至关重要的 今天就一起学习一下,如何 ...
- odoo备份数据库无法还原问题解决:Command 'pg_dump' not found.
背景景:ubuntu20.04 上用命令安装postgresql后,odoo备份数据库报如下错误 安装命令:sudo apt-get install postgresql 默认安装:14版本的pg 错 ...
- 宝塔面板部署java springboot项目
前言 1.此文章用的是腾讯云的云服务器,2H4G,centos7.6,宝塔面板7.9.0 2.安装好宝塔面板,这一过程就不说了,懂得都懂 3.以下准备工作仅为MyAuth需要,如果您的springbo ...
- mysql数据库索引详解,索引优化、分析
1.什么是索引 索引在MySQL中是比较常见的,索引就相当于我们看书的目录,它是帮助MySQL高效获取数据的一种数据结构,主要用来提高数据的检索效率,减少IO成本,同时通过索引对数据进行排序,降低排序 ...
- 鸿蒙Next仓颉语言开发实战教程:店铺详情页
各位好,幽蓝君又来分享仓颉开发教程了,今天的内容是店铺详情页: 这个页面的内容看似简单,其实有很多小细节需要注意,主要还是让大家熟悉List容器的使用. 整个页面由导航栏和List容器两大部分组成,导 ...
- Raft论文(中英翻译)
In Search of an Understandable Consensus Algorithm(Extended Version) 寻找一种可理解的一致性算法(拓展版) 作者:斯坦福大学的Die ...
- ET5.0运行--基础
nodejs转c#,刚刚开始使用ET,在运行Demo中记录了一下. ET5.0 githu: https://github.com/egametang/ET/tree/Branch_V5.0 环境: ...