Project

rails_api_doc

0.0
No commit activity in last 3 years
No release in over 3 years
rails_api_docharkamal/rails_api_docHomepageDocumentationSource CodeBug TrackerWiki
This engine provides the UI for generating documentation for apis using apidocjs - Beta Version
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
17,419
Stars
2
Forks
0
Watchers
1
 Releases
Current version
0.0.8
Total releases
7
First release
2014-04-12
Latest release
2014-04-12
 Development
Primary Language
CSS
Average date of last 50 commits
2014-03-30
Reverse Dependencies
0

 Dependencies

Runtime

kaminari
>= 0.15.1
protected_attributes
>= 1.0.3
rails
>= 3.0.1
 Project Readme

Here are the steps to use rails API Doc for generating API documentaion. This engine uses "apidoc(A RESTful web API Documentation Generator) a node application". The main objective of this engine is to provide web interface for generating api documentation using apidoc without taking care of actual syntax of apidoc. The actual syntax can be reviewed from "http://www.apidocjs.com/"

DEPENDENCY

Install --> npm install apidoc -g

Follow these steps:

  • Place the engine code in rails app --> vendor/engines/ directory

  • Include engine code as a gem --> gem 'rails_api_doc', path: "vendor/engines/rails_api_doc"

  • Mount the engine routes in the application --> mount RailsApiDoc::Engine => "/rails_api_doc"

  • Install the migrations --> rake rails_api_doc:install:migrations

  • Visit Rails API Doc Url --> ROOT_URL/rails_api_doc