{"id":26062418,"url":"https://github.com/work-design/rails_doc","last_synced_at":"2025-03-08T16:00:17.299Z","repository":{"id":33112319,"uuid":"152182961","full_name":"work-design/rails_doc","owner":"work-design","description":"Auto generate Api Doc from rails application","archived":false,"fork":false,"pushed_at":"2024-02-22T06:49:08.000Z","size":82,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-03-26T06:12:41.561Z","etag":null,"topics":["design","work"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/work-design.png","metadata":{"funding":{"github":["qinmingyuan"]},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-09T03:35:52.000Z","updated_at":"2024-08-24T15:44:48.696Z","dependencies_parsed_at":"2024-02-22T07:48:39.992Z","dependency_job_id":null,"html_url":"https://github.com/work-design/rails_doc","commit_stats":null,"previous_names":["yougexiangfa/rails_doc"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/work-design%2Frails_doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/work-design%2Frails_doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/work-design%2Frails_doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/work-design%2Frails_doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/work-design","download_url":"https://codeload.github.com/work-design/rails_doc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242492122,"owners_count":20137575,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["design","work"],"created_at":"2025-03-08T16:00:16.276Z","updated_at":"2025-03-08T16:00:17.194Z","avatar_url":"https://github.com/work-design.png","language":"Ruby","funding_links":["https://github.com/sponsors/qinmingyuan"],"categories":[],"sub_categories":[],"readme":"# RailsDoc\n\n[![测试](https://github.com/work-design/rails_doc/actions/workflows/test.yml/badge.svg)](https://github.com/work-design/rails_doc/actions/workflows/test.yml)\n[![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)\n[![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)\n\n`rails_doc`是一个 从Rails应用 输出 [OpenAPI](https://github.com/OAI/OpenAPI-Specification) 格式文档的工具；\n\n## 功能\n* 记录api版本变化;\n* 开发环境采用手动记录接口;\n* 产品环境自动请求实际接口;\n* 导出json格式;\n\n## 第三方支持\n* 支持rails程序,gem 'rails_doc'\n* 提供对导出的json数据导入的工具;\n\n## UI\n`rails_doc`提供标准open api v3 接口，兼容此标准的api UI有：\n\n* [Swagger UI](https://github.com/swagger-api/swagger-ui)\n* [OpenAPI-GUI](https://github.com/Mermade/openapi-gui)\n* [ReDoc](https://github.com/Rebilly/ReDoc)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwork-design%2Frails_doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwork-design%2Frails_doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwork-design%2Frails_doc/lists"}