rswag

========= 支持 OpenApi 3.0! 寻找维护者! 如果有需要修复的问题,请在问题/提交中告诉我们,您愿意提供帮助。

Rswag 扩展了 rspec-rails 的 "请求规范",并采用基于 Swagger 的 DSL 来描述和测试 API 操作。您可以使用简洁、直观的语法来描述您的 API 操作,它会自动运行测试。一旦您的测试通过,可以运行 rake 任务来自动生成对应的 OpenAPI 文件,并将其作为 YAML 或 JSON 端点进行暴露。Rswag 还提供了一个嵌入式版本的强大 swagger-ui,该版本由暴露的文件提供支持。这种工具链使您可以无缝地从集成规范(您可能已经在某个形式中进行此类规范)过渡到面向 API 客户的生动文档。

Api Rswag 为 Rails API 提供 Swagger 工具。直接从 rspec 集成测试中生成漂亮的 API 文档，包括用于探索和测试操作的 UI。

• rswag
• 开始使用
• rspec DSL
  • 路径、操作和响应
  • 空值
  • 对 oneOf、anyOf 或 AllOf 方案的支持
  • 全局元数据
    • 支持多个版本的 API
    • 格式化描述文本：
  • 指定/测试 API 安全性
• 配置和自定义
  • 生成的 OpenAPI 文件的输出位置
  • rspec 测试的输入位置
  • 引用的参数