Project

webapidoc

0.0
No commit activity in last 3 years
No release in over 3 years
Create a static HTML Documentation for your JSON Web API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

>= 0

Runtime

>= 0.6.1
>= 1.5.5
>= 3.1.19
 Project Readme

Webapidoc

Installation

gem install webapidoc

Rails Generator

To copy sample config/webapidoc.yml and sample files in app/documentation simply run

rails g webapidoc:install

Sample Rake Task

require 'webapidoc'

namespace :webapidoc do

  task :build do
    Webapidoc.build({:title => "Webapidoc"})
  end

end

Provide URL for live API Querys

set url option to a valid JSON API URL to use live querys

Rendering Partials

like in rails:

<%= partial :welcome_message %>