apitest 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81fc56ffb2514081bf6f44b460f844c922f148b5
-  data.tar.gz: 002c7eddb0329509034747a287b19ba04cd3fb2d
+  metadata.gz: 55299bf0b724cded4b82f817901954e4c1341011
+  data.tar.gz: 3d81c1087af86bb04afd07a10d473194846ba83f
 SHA512:
-  metadata.gz: 0e4b74aebaeb67a44a9b7bfe8b51c07c8265684bfdc9e4714b32b17e26b5fd16db3f7624c6d1beafcde041af168ce28d451f3ea6f27a3b764536c59f0aeaf63d
-  data.tar.gz: ef145628b987cab510cf778c7157d5d55dcb63983bfac399b2f338f140b4776a02afdc27d4d53167ab9d219a187405fa283815c6a7e5325158a99a0463fbd4d9
+  metadata.gz: f3770091a42849fb7d1b622c657fc2a1b72eff6c96196de1614c90feead7b0100b236e72f8e43393397fa98dd351619ff8d416adaac735f537dfc20c0afe06ca
+  data.tar.gz: 0e495fccba5f9f3900398425552ae018f50eda845cf7b32363fe510eaea4ec840f2701251f4b17f905692b7d2d9047c9c0f8d7040e4eea8e62710367c56bafaf

data/README.md

@@ -2,7 +2,7 @@
 Short description and motivation.
 
 ## Version 
-0.1.5
+0.1.6
 
 ## Installation
 添加如下代码到 Gemfile:
@@ -33,23 +33,14 @@ $ brew install lsof #MacOS
 
 ## Usage
 
-约定的api目录如下：
-```shell
-├── controllers
-│   ├── api
-│   │   └── v1
-│   │       ├── foo_controller.rb
-│   │       ├── bar_controller.rb
-│   │   └── v2
-│   │       ├── foobar_controller.rb
-│   │       ├── barfoo_controller.rb
-```
-
 在routes.rb 配置apitest 目录，比如：
 
 ```ruby
+Rails.application.routes.draw do
+
   apitest_for '/apitest'
 
+end
 ```
 
 浏览器中访问apitest 的url
@@ -57,32 +48,90 @@ $ brew install lsof #MacOS
 默认api目录为controllers/api，目录可指定
 
 ```ruby
+Rails.application.routes.draw do
+
   apitest_for '/apitest' do 
     Apitest::api_dir 'api'
   end 
+
+end
 ```
 
 默认使用blue-theme，可指定theme ，theme使用 AdminLTE，直接指定AdminLTE的theme即可：
 
 ``` ruby
+Rails.application.routes.draw do
+
   apitest_for '/apitest' do 
     Apitest::theme  'purple-light'
   end
+
+end
 ```
 theme列表如下
 ```
-black-light
 black
-blue-light
+black-light
 blue
-green-light
+blue-light
 green
-purple-light
+green-light
 purple
-red-light
+purple-light
 red
-yellow-light
+red-light
 yellow
+yellow-light
+```
+
+API层级为4级
+Version -> 分类 -> API组 -> API
+其中Version 由第一级目录决定
+分类在API中定义，定义方法如下
+
+```ruby
+class Api::V1::BindingTrayController < Api::V1::ApplicationController
+  APIDOC = {
+    type:      '业务API' ,
+    group_name: '绑定托盘' ,
+    sort:       2 ,
+    apis: {
+      scan_sn: {  #第一条API
+        api_name: '扫描sn' ,
+        path: '/api/v1/binding_tray/scan_sn' ,
+        method: 'get' ,
+        params:{
+          barcode: {
+            text: 'sn条码' ,
+            required: true 
+          } , 
+          detail_id: {
+            text: '托盘列表id' ,
+          }
+        }
+      } ,
+      ... #第二条API
+    }
+  }
+  def scan_sn
+    ... #your code
+  end
+```
+
+默认分类为
+```ruby
+Apitest::default_types  [ '业务API' , '工具API' , '辅助API' ]
+```
+默认分类可配置，例如：
+
+```ruby
+Rails.application.routes.draw do
+
+  apitest_for '/apitest' do 
+    Apitest::default_types  [ '银行业务API' , '企业业务API'  ]
+  end
+
+end
 ```
 
 
@@ -90,8 +139,16 @@ yellow
 ## TODO
 - [x] 可自定义api目录
 - [x] 可自定义theme
+- [x] 可配置分类
+- [ ] 可设定所有API都有的必填项，比如token、客户端类型、客户端版本号
 - [ ] ERROR类工具
-- [ ] APIDOC美化
+- [ ] Apitest Example 网站
+- [ ] 使用前端route
+- [ ] 保存API分类收起展开状态
+- [ ] ERROR log 可选输出
+- [ ] 一个token默认机制
+- [ ] 客户端版本号默认升级实例
+- [ ] 操作录屏gif
 - [ ] 权限控制
 - [ ] 测试数据准备，测试用例
 - [ ] 测试中心

data/app/controllers/apitest/apitest_controller.rb

@@ -26,13 +26,6 @@ module Apitest
       @root_url = main_app.root_url[0,main_app.root_url.length - 1]
     end  
 
-    def docs_base 
-      {
-        '业务API' => [] ,
-        '工具API' => [] ,
-        '辅助API' => []
-      }
-    end
     def get_doc(path_root = nil)
       path_root ||= "app/controllers/#{Apitest.api_dir}/"
       Dir.glob("#{path_root}*").each do |path|
@@ -41,7 +34,7 @@ module Apitest
     end
 
     def get_version_doc(path_root)
-      docs = docs_base
+      docs = Apitest::default_types.clone
       Dir.glob("#{path_root}/*").each do |path|
         if File.directory?(path)
           docs = docs.merge get_version_doc(path)

data/lib/apitest/version.rb

@@ -1,3 +1,3 @@
 module Apitest
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/lib/apitest.rb

@@ -12,6 +12,7 @@ require 'websocket-eventmachine-server'
 module Apitest
   @api_dir
   @theme
+  @default_types
 
   def self.api_dir(dir = nil)
     @api_dir = dir if dir
@@ -22,7 +23,14 @@ module Apitest
     @theme = theme if theme
     @theme
   end
-  
+
+  def self.default_types(default_types = [])
+    @default_types ||= {}
+    default_types.each do |type|
+      @default_types[type] = []
+    end
+    @default_types
+  end
   def self.start_server_log_listen
     Process.detach(
       fork do
@@ -64,8 +72,9 @@ module ActionDispatch::Routing
   class Mapper
     def apitest_for(path , &block)
       mount Apitest::Engine => path
-      Apitest::api_dir    'api'
-      Apitest::theme      'blue-light'
+      Apitest::api_dir        'api'
+      Apitest::theme          'blue-light'
+      # Apitest::default_types  [ '业务API' , '工具API' , '辅助API' ]
       block.call
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apitest
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Kyuubi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2017-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails