https://github.com/work-design/rails_doc

Auto generate Api Doc from rails application
https://github.com/work-design/rails_doc

design work

Last synced: over 1 year ago
JSON representation

Auto generate Api Doc from rails application

• Host: GitHub
• URL: https://github.com/work-design/rails_doc
• Owner: work-design
• License: mit
• Created: 2018-10-09T03:35:52.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-02-22T06:49:08.000Z (over 2 years ago)
• Last Synced: 2024-03-26T06:12:41.561Z (over 2 years ago)
• Topics: design, work
• Language: Ruby
• Homepage:
• Size: 80.1 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# RailsDoc

[![测试](https://github.com/work-design/rails_doc/actions/workflows/test.yml/badge.svg)](https://github.com/work-design/rails_doc/actions/workflows/test.yml)

[![Docker构建](https://github.com/work-design/rails_doc/actions/workflows/cd.yml/badge.svg)](https://github.com/work-design/rails_doc/actions/workflows/cd.yml)

[![Gem](https://github.com/work-design/rails_doc/actions/workflows/gempush.yml/badge.svg)](https://github.com/work-design/rails_doc/actions/workflows/gempush.yml)

`rails_doc`是一个 从Rails应用 输出 [OpenAPI](https://github.com/OAI/OpenAPI-Specification) 格式文档的工具；

## 功能

* 记录api版本变化;

* 开发环境采用手动记录接口;

* 产品环境自动请求实际接口;

* 导出json格式;

## 第三方支持

* 支持rails程序,gem 'rails_doc'

* 提供对导出的json数据导入的工具;

## UI

`rails_doc`提供标准open api v3 接口，兼容此标准的api UI有：

* [Swagger UI](https://github.com/swagger-api/swagger-ui)

* [OpenAPI-GUI](https://github.com/Mermade/openapi-gui)

* [ReDoc](https://github.com/Rebilly/ReDoc)