Basic API autodoc

Lists EndPoints at /api

Basic API autodoc
Lists EndPoints at /api
Aurélio A. Heckert · Rodrigo Souto
1 parent cc60c41d
Showing 4 changed files with 29 additions and 0 deletions Show diff stats
app/controllers/public/api_controller.rb
app/views/api/index.html.erb
config/routes.rb
lib/noosfero/api/api.rb
@@ -0,0 +1,9 @@
+class ApiController < PublicController
+
+  no_design_blocks
+
+  def index
+    @api = Noosfero::API.api_class
+  end
+
+end
@@ -0,0 +1,16 @@
+<h1>EndPoints</h1>
+
+<%= @api.endpoints.map do |endpoint|
+  app = endpoint.options[:app].to_s
+  unless app.blank?
+    content_tag(:h2, app.split('::').last.to_s, title: app) +
+    (content_tag :ul do
+      endpoint.routes.map do |route|
+        content_tag :li do
+          content_tag(:strong, route.route_method) + ' ' +
+          route.route_path.gsub(':version', content_tag(:b, route.route_version))
+        end
+      end.join "\n"
+    end)
+  end
+end.join "\n" %>
@@ -22,6 +22,7 @@ Noosfero::Application.routes.draw do
   root :to => 'home#index', :constraints => EnvironmentDomainConstraint.new
   match 'site(/:action)', :controller => 'home'
+  match 'api(/:action)', :controller => 'api'
   match 'images(/*stuff)' => 'not_found#nothing'
   match 'stylesheets(/*stuff)' => 'not_found#nothing'
@@ -45,5 +45,8 @@ module Noosfero
         end
       end
     end
+    def self.api_class
+      API
+    end
   end
 end
@@ -0,0 +1,9 @@		@@ -0,0 +1,9 @@
	1	+class ApiController < PublicController
	2	+
	3	+ no_design_blocks
	4	+
	5	+ def index
	6	+ @api = Noosfero::API.api_class
	7	+ end
	8	+
	9	+end
@@ -0,0 +1,16 @@		@@ -0,0 +1,16 @@
	1	+<h1>EndPoints</h1>
	2	+
	3	+<%= @api.endpoints.map do \|endpoint\|
	4	+ app = endpoint.options[:app].to_s
	5	+ unless app.blank?
	6	+ content_tag(:h2, app.split('::').last.to_s, title: app) +
	7	+ (content_tag :ul do
	8	+ endpoint.routes.map do \|route\|
	9	+ content_tag :li do
	10	+ content_tag(:strong, route.route_method) + ' ' +
	11	+ route.route_path.gsub(':version', content_tag(:b, route.route_version))
	12	+ end
	13	+ end.join "\n"
	14	+ end)
	15	+ end
	16	+end.join "\n" %>
	@@ -22,6 +22,7 @@ Noosfero::Application.routes.draw do		@@ -22,6 +22,7 @@ Noosfero::Application.routes.draw do
22	root :to => 'home#index', :constraints => EnvironmentDomainConstraint.new	22	root :to => 'home#index', :constraints => EnvironmentDomainConstraint.new
23		23
24	match 'site(/:action)', :controller => 'home'	24	match 'site(/:action)', :controller => 'home'
		25	+ match 'api(/:action)', :controller => 'api'
25		26
26	match 'images(/*stuff)' => 'not_found#nothing'	27	match 'images(/*stuff)' => 'not_found#nothing'
27	match 'stylesheets(/*stuff)' => 'not_found#nothing'	28	match 'stylesheets(/*stuff)' => 'not_found#nothing'