work-design / rails_doc

Auto generate Api Doc from rails application

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

RailsDoc

测试 Docker构建 Gem

rails_doc是一个 从Rails应用 输出 OpenAPI 格式文档的工具;

功能

  • 记录api版本变化;
  • 开发环境采用手动记录接口;
  • 产品环境自动请求实际接口;
  • 导出json格式;

第三方支持

  • 支持rails程序,gem 'rails_doc'
  • 提供对导出的json数据导入的工具;

UI

rails_doc提供标准open api v3 接口,兼容此标准的api UI有:

About

Auto generate Api Doc from rails application

License:MIT License


Languages

Language:Ruby 83.2%Language:HTML 13.9%Language:JavaScript 2.2%Language:CSS 0.6%