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.生成示例 ...
随机推荐
- K8s新手系列之Service资源
概述 官方文档:https://kubernetes.io/zh-cn/docs/concepts/services-networking/service/ 在kubernetes中,pod是应用程序 ...
- np.where与pd.Series.where,pd.DataFrame.where的用法及区别
np.where与pd.Series.where及pd.DataFrame用法不一样,下面一一进行学习,总结: import numpy as np import pandas as pd help( ...
- Solon Ai Flow 编排开发框架发布预告(效果预览)
Solon Ai 在推出 Solon Ai Mcp 后,又将推出 Solon Ai Flow. 1.Solon Ai Flow 是个啥? Solon Ai Flow 是一个智能体编排开发框架(基于 s ...
- 【教程】Ubuntu 16.04 配置 CLion 开发 ROS Melodic
[教程]Ubuntu 16.04 配置 CLion 开发 ROS Melodic 目录 [教程]Ubuntu 16.04 配置 CLion 开发 ROS Melodic 笔者环境 步骤 下载安装 CL ...
- WindowsPE文件格式入门09.RadAsm的bug和重定位表
https://www.bpsend.net/thread-383-1-1.html RadAsm的bug 创建程序 1.创建程序1:C++工程: ●项目选项:控制台"hello,World ...
- MVVM-命令模式的实现与应用
MVVM-命令模式的实现与应用 本文同时为b站WPF课程的笔记,相关示例代码 绑定 这个其实前面已经讲过一部分 使用{Binding}设置数据绑定,将控件的属性绑定到 ViewModel 的相应属性. ...
- 「Log」NOIP 2023 游记
Day 0 打了大半天板子,然后开摆. 打块,快下班的时候玩了猜词游戏. 回家睡大觉. Day 1 早上起床状态良好,收拾收拾就出门了,跟爸妈吃了肯德基,然后坐车到三校区. 才看到 cc0000 之前 ...
- 【图像处理】使用matplotlib库显示灰度图像为自定义颜色(2)
在下面的代码中,facies_img的值只有[0,1,2]表明图像是灰度图像.通过下面的代码可以让图像显示为彩色图像 import matplotlib.pyplot as plt import ma ...
- AppBox拖拽设计增删改查用户界面
之前为了应对客制化大屏设计的需求,在框架内实现了拖拽方式(动态化)生成用户界面的功能,跟大部分实现方式差不多,设计时生成配置json,然后在运行时解析json生成用户界面.这次完善了一下该功能,支 ...
- linux系统qcow2镜像的制作
一.简单说明 PS: 最近有客户需要在云平台上部署我们的产品,好久没有做过qcow2镜像了,这里还是把制作流程记录下来. QCOW2镜像格式是Qemu支持的磁盘镜像格式之一.它可以使用一个文件来表示一 ...