RapiDoc
用于查看Open-API等级库的自定义图元
> 赞助 祖普洛 -几分钟内为您的客户获得条纹状API体验-几分钟内完成文档、费率限制和API-key验证。
特性
- 支持Swagger 2.0、OpenAPI 3.x.x
- 适用于任何框架或无框架
- 允许进行API调用
- 更好的可用性,
- 默认情况下,所有模型和示例都已展开,无需单击和显示。
- 请求字段预先填充了示例数据
- 只需单击一次即可进行API调用
- 请求和响应可以并排放置,便于比较
- 品牌和个性化功能使遵循任何风格指南变得容易
- 有2个主题(黑暗和光明)
- 将默认徽标替换为您的徽标
- 排版,允许更改字体
- 允许更改文本颜色、按钮颜色、标题颜色和其他UI元素的颜色
- 大量定制选项
- 在文档的顶部和底部添加外部内容,您可以添加图像、链接、文本、表单等
- 允许禁用API调用功能
- 隐藏头部,这样用户就无法加载任何其他OpenAPI规范
- 隐藏身份验证并提供您自己的预生成api密钥
- 将其嵌入到另一个HTML文档中
- 在另一个框架内使用它(反应、真空度、角度、发光元素)
- 使用JavaScript更改其属性,它将对这些更改做出反应
- 使用标准css设置元素样式(更改填充、位置、边框、边距)
- 重量轻,速度快
- 从磁盘加载本地json规范
- 支持Chrome、FireFox和Safari浏览器。(尚未在Edge上测试)
文档
查看用法和演示
例子
示例和测试用例
构建过程```bash
Clone / Download the project then
npm install
build will generate rapidoc-min.js, this is the only file you will need.
use it in the script tag of your html
npm run build
for development use yarn serve (this will start an webserver at port 8080, then navigate to localhost:8080)
npm run serve
```
路线图
- ✅ 升级使用
lit 2 - RapiDoc的预渲染/服务器端渲染(SSR)
- 使用RapiPDF改进OpenAPI规范的PDF生成
- 创建命令行界面(CLI),使其易于自动化
- 添加本地化支持
- 遵循网络内容无障碍指南(WCAG 2)
- 改进主页、文档和示例
- 为自动化测试奠定基础
- 创建一个现场游乐场(类似于swagger编辑器)
- 制作一个简短的动画/视频,展示RapiDoc/RapiPDF的工作原理
