apidoco 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b50213662ec2a1915fb036922e4df1c22dc93466
-  data.tar.gz: 1fa99c664b15ed0713e2dae12d5f697ceecc2331
+  metadata.gz: 61a9a63bafe1c09be4ba6bed4cf2a847d2b63566
+  data.tar.gz: 63ae62823ec4e45a5ea1c2fdd63ea38545a353b9
 SHA512:
-  metadata.gz: 13cc77b6575ac454869087f7a961fa67d71bf6372131d00705b6563004418d8948d1ecd34564afaa4505621ec8e9ed6d3fa917793e6d00ab158bcb53c07f9af4
-  data.tar.gz: ac3f2ffd8b016b42002793954fd9d7455eab48360843a94e4eb508567ab644c60c9dc42070dce37f68353f1502370ccc2ec89a75aea9b0a495a3ea37fd61d532
+  metadata.gz: ea8fd13490b230ca396c120a3d70695d05a98b8885fcb49ccb0642e69d961495856c22a8522bea135d0d1f075e1c0309b625baa3fa517b4db013dc7cc747527e
+  data.tar.gz: 15573fefb5b00fe426b38f0ea323c0b39b355b7915737e2f13780f093167cfeccd0b41eb5ac4b768c22838f1fa443c1696e6f512abfda18b4a309fe7c7149aed

data/README.md

@@ -7,6 +7,8 @@ Easy documentation of REST APIs - [Demo](https://apidoco-demo.herokuapp.com/docs
 
 ![screeshot 1](https://github.com/72pulses/apidoco/blob/master/images/1.jpg?raw=true)
 
+![screeshot 2](https://github.com/72pulses/apidoco/blob/master/images/2.jpg?raw=true)
+
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -72,105 +74,111 @@ will create the following files with sample content
 // docs/api/v1/posts/create.json
 {
   "published": true,
+  "name": "Create",
   "sort_order": 1,
-  "name": "Create Post",
-  "end_point": "/posts",
+  "end_point": "api/v1/posts/:id.json",
   "http_method": "POST",
-  "header": {
-    "Authorization": "Token token=token"
-  },
   "params": [{
-    "key": "post['name']",
+    "key": "post[title]",
+    "required": true,
+    "type": "String",
+    "description": "Title of the post",
+    "validations": ["Should be less than or equal to 40 characters"]
+  }, {
+    "key": "post[content]",
     "required": true,
-    "type": "String"
+    "type": "String",
+    "description": "Content/Body of the post",
+    "validations": ["Should be less than or equal to 300 characters"]
   }, {
-    "key": "post['content']",
-    "required": false
+    "key": "post[publsihed]",
+    "required": true,
+    "type": "Boolean",
+    "description": "Published status of the post"
   }],
-  "notes": [
-    "Authorization Token Need to be passed via header"
-  ],
+  "header": {
+    "Authentication": "Token token=<token>",
+    "Content-Type": "application/json"
+  },
   "examples": [{
     "request": {
       "post": {
-        "name": "I was scared",
-        "content": "I am serious, I was really scared."
+        "title": "Ruby is awesome",
+        "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec interdum a tellus sed finibus.",
+        "published": false
       }
     },
     "response": {
-      "success": true,
-      "message": "Post was successfully created",
-      "post": {
-        "id": 101
-      }
+      "suceess": true,
+      "message": "Successfully created"
     }
   }]
 }
 ```
 
 ```
-// docs/api/v1/posts/edit.json
+// docs/api/v1/posts/update.json
 {
   "published": true,
+  "name": "Update",
   "sort_order": 2,
-  "name": "Edit Post",
-  "end_point": "/posts",
-  "http_method": "POST",
+  "end_point": "api/v1/posts/:id.json",
+  "http_method": "PUT|PATCH",
   "params": [{
-    "key": "post['name']",
+    "key": "post[title]",
+    "required": true,
+    "type": "String",
+    "description": "Title of the post",
+    "validations": ["Should be less than or equal to 40 characters"]
+  }, {
+    "key": "post[content]",
     "required": true,
-    "type": "String"
+    "type": "String",
+    "description": "Content/Body of the post",
+    "validations": ["Should be less than or equal to 300 characters"]
   }, {
-    "key": "post['content']",
-    "required": false,
-    "type": "String"
+    "key": "post[publsihed]",
+    "required": true,
+    "type": "Boolean",
+    "description": "Published status of the post"
   }],
+  "header": {
+    "Authentication": "Token token=<token>",
+    "Content-Type": "application/json"
+  },
   "examples": [{
     "request": {
       "post": {
-        "name": "I was scared",
-        "content": "I am serious, I was really scared."
+        "title": "Ruby is awesome",
+        "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec interdum a tellus sed finibus.",
+        "published": false
       }
     },
     "response": {
-      "success": true,
-      "message": "Post was successfully created",
-      "post": {
-        "id": 101
-      }
+      "suceess": true,
+      "message": "Successfully updated"
     }
   }]
 }
 
+```
+
+```
 //docs/api/v1/posts/delete.json
 {
   "published": true,
-  "sort_order": 3,
-  "name": "Delete Post",
-  "end_point": "/posts",
-  "http_method": "POST",
-  "params": [{
-    "key": "post['name']",
-    "required": true,
-    "type": "String"
-  }, {
-    "key": "post['content']",
-    "required": false,
-    "type": "String"
-  }],
+  "name": "Destroy Post",
+  "sort_order": 6,
+  "end_point": "api/v1/posts/:id.json",
+  "http_method": "DELETE",
+  "header": {
+    "Authentication": "Token token=<token>",
+    "Content-Type": "application/json"
+  },
   "examples": [{
-    "request": {
-      "post": {
-        "name": "I was scared",
-        "content": "I am serious, I was really scared."
-      }
-    },
     "response": {
-      "success": true,
-      "message": "Post was successfully created",
-      "post": {
-        "id": 101
-      }
+      "suceess": true,
+      "message": "Successfully destroyed"
     }
   }]
 }
@@ -182,11 +190,12 @@ will create the following files with sample content
 | Key | Description | Default | Example |
 | --- | --- | --- | --- |
 | `published` | Set this to false if you do not want to list this api | `true` | -- |
-| `sort_order` | The  order of the api in the documenatation | 0 | `"sort_order": 10` |
 | `name` | Name of the api | --- | --- |
+| `sort_order` | Order of the api to be listed | --- | --- |
 | `end_point` | --- | --- | `"end_point": "/posts"` |
 | `http_method` | The HTTP method of the API | --- | `"http_method": "GET"` |
-| `params` | Parameters to be used | --- | `"params: [{ "key": "post['name']",    "required": true, "type": "String" }]"` |
+| `params` | Parameters to be used | --- | `"params: [{ "key": "post['name']", "required": true, "type": "String", "notes": ["Name or title of the post"], "validations": ["should be less than or equal to 150 characters"] }]"` |
+| `header` | headers to be used | --- | `"header: { "Authorization": "Token token=<token>", "Content-type": 'application/json' }"` |
 | `examples` | Array of sample requests and responses | --- | `[{ "request": { "post": { "name": "I was scared" } } }, "response": { "message": "Post was successfully created", "id": 101 } }]`
 
 

data/Rakefile

@@ -14,7 +14,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
 
 load 'rails/tasks/engine.rake'
 
@@ -28,7 +28,7 @@ require 'rspec/core'
 
 require 'rspec/core/rake_task'
 
-desc "Run all specs in spec directory (excluding plugin specs)"
+desc 'Run all specs in spec directory (excluding plugin specs)'
 RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
 
 task default: :spec

data/app/assets/javascripts/apidoco/apidoco_app.js

@@ -1,3 +1 @@
-angular.module('apiDocoApp', ['duScroll', 'ngclipboard'])
-.value('duScrollOffset', 250) // offset from top to the div
-.value('duScrollBottomSpy', true); // To make the last du-scrollspy link active when scroll reaches page/container bottom
+angular.module('apiDocoApp', ['ngclipboard']);

data/app/assets/javascripts/apidoco/application.js

@@ -16,7 +16,6 @@
 //= require apidoco/jquery.json-viewer
 //= require apidoco/bootstrap/bootstrap.min
 //= require apidoco/clipboard.min
-//= require apidoco/directives/angular_scroll.min
 //= require apidoco/directives/ngclipboard
 //= require apidoco/apidoco_app
 //= require apidoco/directives/jq_json_viewer

data/app/assets/javascripts/apidoco/controllers/documentations_controller.js

@@ -9,6 +9,15 @@ angular.module('apiDocoApp')
     $window.location.href = version.path;
   };
 
+  $scope.viewRaw = function(data) {
+    var dataStingified = JSON.stringify(data, null, 2);
+    var x = window.open();
+
+    x.document.open();
+    x.document.write('<html><body><pre>' + dataStingified + '</pre></body></html>');
+    x.document.close();
+  };
+
   $scope.initMenuToggle = function() {
     $(document).ready(function () {
       $("#menu-toggle").click(function(e) {

data/app/assets/javascripts/apidoco/directives/jq_json_viewer.js

@@ -8,6 +8,9 @@ angular.module('apiDocoApp').directive('jqJsonViewer', [function() {
     },
     link: function(scope, elem, attrs) {
       $(elem).jsonViewer(scope.data, { withQuotes: true });
+
+      // Collapse the second level
+      $(elem).find('ul.json-dict > li > ol > li > a.json-toggle').click();
     }
   };
 }]);

data/app/assets/stylesheets/apidoco/custom.css

@@ -17,4 +17,26 @@ pre {
   background-color: #f6f8fa;
   border-radius: 3px;
   border: none;
-}
+}
+
+h2.section-title {
+  font-size: 20px;
+  font-weight: bold;
+  border-bottom: 1px solid #ededed;
+  padding-bottom: 10px;
+}
+
+.section-block {
+  padding-bottom: 15px;
+  padding-top: 15px;
+}
+
+h3 {
+  font-size: 14px;
+  font-weight: bold;
+}
+
+.section-block .block-title {
+  margin-top: 0;
+}
+

data/app/assets/stylesheets/apidoco/helpers.css

@@ -3,6 +3,10 @@
   cursor: pointer;
 }
 
+.mt-2 {
+  margin-top: 2px !important;
+}
+
 .mt-10 {
   margin-top: 10px !important;
 }
@@ -10,3 +14,4 @@
 .padding-10 {
   padding: 10px !important;
 }
+

data/app/assets/stylesheets/apidoco/simple-sidebar.css

@@ -19,26 +19,27 @@
 }
 
 #wrapper.toggled {
-    padding-left: 250px;
+    padding-left: 275px;
 }
 
 #sidebar-wrapper {
     z-index: 1000;
     position: fixed;
-    left: 250px;
+    left: 275px;
     width: 0;
     height: 100%;
-    margin-left: -250px;
+    margin-left: -275px;
     overflow-y: auto;
-    background: #000;
+    background: #364150;
     -webkit-transition: all 0.5s ease;
     -moz-transition: all 0.5s ease;
     -o-transition: all 0.5s ease;
     transition: all 0.5s ease;
+    color: #b4bcc8;
 }
 
 #wrapper.toggled #sidebar-wrapper {
-    width: 250px;
+    width: 275px;
 }
 
 #page-content-wrapper {
@@ -49,7 +50,7 @@
 
 #wrapper.toggled #page-content-wrapper {
     position: absolute;
-    margin-right: -250px;
+    margin-right: -275px;
 }
 
 /* Sidebar Styles */
@@ -57,21 +58,21 @@
 .sidebar-nav {
     position: absolute;
     top: 0;
-    width: 250px;
+    width: 95%;
     margin: 0;
     padding: 0;
+    margin-left: 10px;
     list-style: none;
 }
 
 .sidebar-nav li {
-    text-indent: 20px;
-    line-height: 40px;
+    margin-bottom: 3px;
 }
 
 .sidebar-nav li a {
     display: block;
     text-decoration: none;
-    color: #999999;
+    color: #b4bcc8;
 }
 
 .sidebar-nav li a:hover,
@@ -97,10 +98,14 @@
     color: #fff;
     background: none;
 }
+.sidebar-nav ul {
+    margin-bottom: 20px !important;
+    padding-left: 30px !important;
+}
 
 @media(min-width:768px) {
     #wrapper {
-        padding-left: 250px;
+        padding-left: 275px;
     }
 
     #wrapper.toggled {
@@ -108,7 +113,7 @@
     }
 
     #sidebar-wrapper {
-        width: 250px;
+        width: 275px;
     }
 
     #wrapper.toggled #sidebar-wrapper {

data/app/controllers/apidoco/apis_controller.rb

@@ -1,4 +1,4 @@
-require_dependency "apidoco/application_controller"
+require_dependency 'apidoco/application_controller'
 
 module Apidoco
   class ApisController < ApplicationController

data/app/helpers/apidoco/application_helper.rb

@@ -5,5 +5,17 @@ module Apidoco
         { name: documentation.name, path: api_path(id: documentation.name) }
       end
     end
+
+    def build_documentation_array(documentations)
+      documentation_array = documentations.map do |documentation|
+        if documentation[:is_folder]
+          build_documentation_array(documentation[:children])
+        else
+          documentation
+        end
+      end
+
+      documentation_array.flatten
+    end
   end
 end

data/app/views/apidoco/apis/_side_bar.html.erb

@@ -1,3 +1,12 @@
+<!-- recursive template -->
+<script type="text/ng-template" id="documentationTree">
+  <a href="#{{documentation.id}}">{{documentation.name}}</a>
+  <ul ng-if="documentation.children">
+    <li ng-repeat="documentation in documentation.children" ng-include="'documentationTree'">
+    </li>
+  </ul>
+</script>
+
 <div id="sidebar-wrapper">
   <ul class="sidebar-nav">
     <li class="sidebar-brand">
@@ -13,8 +22,7 @@
     <li class="mt-10 padding-10">
       <input type="text" placeholder="Search.." class="form-control input-sm" ng-model="searchKeyword" />
     </li>
-    <li ng-repeat="x in jsonItem.apis | filter: searchKeyword">
-      <a href="#api_{{$index}}" du-smooth-scroll du-scrollspy>{{x.name}}</a>
+    <li ng-repeat="documentation in data.apis | filter: searchKeyword" ng-include="'documentationTree'">
     </li>
   </ul>
 </div>