Project

rails_doc

0.0
No release in over 3 years
Description of RailsDoc.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

~> 5.2.1
 Project Readme

RailsDoc

测试 Docker构建 Gem

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

功能

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

第三方支持

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

UI

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