RapiDoc

生成基于 OpenAPI 规范的 API 文档
授权协议 MIT
开发语言 JavaScript
所属分类 开发工具、 程序文档工具
软件类型 开源软件
地区 不详
投 递 者 蒲功
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

RapiDoc 是一个文档工具,可以基于 OpenAPI 规范创建漂亮的、可定制的、交互式的 API 文档。

特征

  • 支持Swagger 2.0和OpenAPI 3.0
  • 适用于任何框架或不需要框架
  • 允许进行API调用
  • 更好的可用性
    • 默认情况下,所有模型和示例均已扩展,因此无需单击并显示。
    • 请求字段已预先填充了示例数据
    • 只需单击一下即可进行API调用
    • 请求和响应可以并排放置以便于比较
  • 大量的自定义选项
    • 在文档的顶部和底部添加外部内容,可以添加图像、链接、文本、表格等
    • 允许禁用API调用功能
    • 将其嵌入另一个HTML文档中
    • 在另一个框架中使用它(react,vue,angular,lit-element)
    • 使用JavaScript更改其属性,它将对这些更改做出反应
    • 使用标准CSS设置元素的样式(更改填充,位置,边框,边距)
  • 轻巧快速
  • 从磁盘加载本地json规范
  • 在Chrome、FireFox和Safari上受支持。(尚未在Edge上测试)
 相关资料
  • 对于来说,肯定有某种方法可以产生这个输出,不是吗?我发现有一些将映射到,所以似乎有一种方法可以让它产生类型,但我没有找到

  • 我正在从swagger(Open API 2)转向springdoc(Open API 3),但今天在某些情况下,我使用swagger-codemen-maven-plugin从yaml生成代码(用于客户端和提供商),遵循合同优先策略。下面是配置示例: 使用springdoc openapi maven插件生成代码有没有等效的选项?

  • 我有一个Spring Boot(kotlin)项目,我使用springdoc openapi生成openapi 3规范。我的数据模型如下所示: 还有一个简单的控制器,如下所示: 生成的yaml为: 这里的问题是我的控制器可以返回或,这在返回类型中指定。我期望生成的模式是: 有没有办法做到这一点?

  • 我想问是否有一种方法可以简单地从不同的API中聚合OpenApi规范? 目前,我们为每个API添加了用户招摇过市的功能,并在其中添加了用于身份验证的自定义逻辑,我们还为不同的可访问性规则添加了规则。 然而,以某种方式聚合所有这些API,并将身份验证、访问逻辑保持在同一位置,会更方便。 例: 我们有两个独立的微服务,有独立的API和独立的地址 API 1localhost:5000 使用Orders

  • 我有一个OpenAPI规范,我使用了来生成Golang服务器。 从OpenAPI规范生成Swagger documentation server的常规方法是什么? 我已经尝试过swag:它会在http://localhost:8080/swagger/index.html终点。但这需要在代码注释中描述API。我正在寻找一个来自OpenAPI规范的大摇大摆的UI生成器,我已经有了。 谢谢

  • 我使用的是Swashbuckle(5.3.2),它生成了一个很好的API文档。 PetController CarController WebApiConfig null 获取/api/pets post/api/pets 获取/api/pets/{id} carowner_api_key: 汽车 get/api/cars 邮政/API/CARS get/api/cars/{id} null nu

  • 在我的Spring项目中,我使用Springdoc生成OpenApiSpecification文档。我用这些注释创建了我的Api。我想用不同的mediatype拥有相同的endpointurl来处理不同对象的POST。 生成的开放式Api规范文档为: 我有几个问题: > 终结点名称没有意义(保存\u 1) 当我使用OpenAPI生成器根据此规范生成Angular客户端时,我收到一些警告,这些警告会

  • 我有yaml格式的OpenAPI3.0规范和从它生成代码的应用程序。一切工作都很好,除了生成昂首阔步的UI。我使用spring-fox来生成它,但它似乎从控制器生成了霸气的UI2.0版本,这些控制器是从openapi规范生成的。 我如何直接从3.0规范而不是从3.0openapi规范生成的控制器生成昂首阔步的ui?