【文件属性】:
文件名称:api_docs_engine:带有Postgres和Bootstrap的Rails 4的API文档引擎
文件大小:33KB
文件格式:ZIP
更新时间:2021-05-07 00:51:25
Ruby
Rails 4的API文档引擎
ApiDocsEngine提供了简单的UI来管理您的应用程序的API文档。 使用Markdown语法存储在db中的文档(当前仅支持PostgreSQL> = 9.2)。 UI使用Bootstrap,Turbolinks和Highlight.js。
目前gem是非常原始的,需要更多文档。
安装
将此行添加到您的应用程序的Gemfile中:
gem 'api_docs_engine'
然后执行:
$ bundle
产生迁移:
$ rails g api_docs_engine docs
$ rake db:migrate
生成初始值设定项:
$ rails g api_docs_engine:install
与BootInquirer一起使用
注意:您不应该在应用程序的Gemfile中添加'api_docs_engine' 。
创建新的docs引擎
【文件预览】:
api_docs_engine-master
----.gitignore(185B)
----app()
--------assets()
--------models()
--------helpers()
--------views()
--------controllers()
----LICENSE.txt(1KB)
----README.md(2KB)
----config()
--------routes.rb(76B)
----lib()
--------bootstrap()
--------api_docs_engine()
--------generators()
--------api_docs_engine.rb(52B)
--------docs()
----api_docs_engine.gemspec(1KB)
----Gemfile(100B)
----Rakefile(29B)