apitest 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4c952cd85e1b81d7f680d663d77b1d0525ede63
-  data.tar.gz: 2ffbda569a158b43255fab59cd8216cd7eea9f8a
+  metadata.gz: b0633ebdeafbf793f850ec77c572c6e10687c1aa
+  data.tar.gz: c8a24eb02574bf285718e4b2a1ea651168e11193
 SHA512:
-  metadata.gz: 838ae386e16075d421b9aca54a28702c670d966eedba3eaefcb8dc989fa25318ed946d7109f969e3c70c810b508123bb2580d2e13c713354a195fbcaebeebfe9
-  data.tar.gz: 871dfc1d7b8cd81794b54296b75b5be9c9cf7a837a3d74c94858dcd6841785ce77990b8c5922e489fb128dda73665a6573d61a09247d1aa4b479d1e30e78585b
+  metadata.gz: 4f9234362ef3cb83cc44be3368aee0a21c8d6c82bbf1d1d2d5a67b28ffb010090372e4858aab9749071d7b719de690bfab6a3c36e7d60279200d386fc0a2f994
+  data.tar.gz: b96dc2f3036ffd72dec49ab2744cd491ffab60b8f92e059b361e268801c35e78588ba419248d1b71a197029fc75ba7d8b0f9235ecff95239070255642414ba5f

data/README.md

@@ -1,8 +1,11 @@
 # Apitest
-Short description and motivation.
+- 通过在API controller里的常量，配置API文档
+- 并附带一个测试界面，辅助API开发。
+- 适用与API开发人员，客户端/前端开发人员交流验证文档。
+- 目前无出参，需要提交后，得到无法完全替代API文档
 
 ## Version 
-0.1.8
+0.1.9
 
 ## Installation
 添加如下代码到 Gemfile:

data/app/assets/javascripts/apitest/application.coffee

@@ -45,25 +45,24 @@ $(document).on "turbolinks:load" , ->
           elm         = $(e.target).parents('.api')
           result      = elm.find('.result')
           result_pre  = elm.find('.result_pre')
-          path        = elm.find('.path').val()
+          path        = elm.find('.path').val().replace ':id' , elm.find('.params[name=":id"]').val()
           method      = elm.find('.method').text()
           postData    = {}
 
           elm.find('.params').each ->
-            postData[$(this).attr('name')] = $(this).val()
+
+            postData[$(this).attr('name')] = $(this).val() unless $(this).attr('name').indexOf(':id') >= 0
           
           $.ajax 
             url       : path
             type      : method
             data      : postData
             success   : (data) =>
-              # result.val JSON.stringify(data , null , 4)
               result_pre.jsonViewer(data)
             error     : (data) =>
               result.val data.responseText
 
         clear_result  : (e) ->
-          # $(e.target).parents('.api').find('.result').val('')
           $(e.target).parents('.api').find('.result_pre').html('')
 
         log_scroll : ->

data/app/controllers/apitest/apitest_controller.rb

@@ -42,17 +42,12 @@ module Apitest
           class_match      = File.open(path).read.match(/class (.*) </)
           controller_class = class_match[1].constantize if class_match && class_match[1]
           if defined? controller_class::APIDOC
-            token_need = {
-              token: {
-                text:     'token' ,
-                required: true ,
-              }
-            } 
             doc = controller_class::APIDOC 
             doc[:sort] = 99 if doc[:sort].blank?
             doc[:apis].each do |k,v|
-              doc[:apis][k][:params] = token_need.merge doc[:apis][k][:params] unless v[:token] == false
-              # doc[:apis][k][:params] = general_need
+              d = doc[:apis][k]
+              d           = public_required d                               unless Apitest::public_required.blank? 
+              d[:params]  = {':id' => { required: true }}.merge d[:params]  if d[:path].include? ':id'
             end 
             
             docs[doc[:type]] = [] if docs[doc[:type]].blank?
@@ -62,8 +57,11 @@ module Apitest
       end
       docs
     end
-    def general_need(api_params)
-
+    def public_required(api)
+      Apitest::public_required.reverse.each do |need|
+        api[:params] = need.merge api[:params] if api[need.keys.first.to_sym] != false
+      end 
+      api
     end
   end
 end

data/lib/apitest/version.rb

@@ -1,3 +1,3 @@
 module Apitest
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

data/lib/apitest.rb

@@ -13,7 +13,7 @@ module Apitest
   @api_dir
   @theme
   @default_types
-  @general_need
+  @public_required
   class << self
     def api_dir(dir = nil)
       @api_dir = dir if dir
@@ -34,13 +34,14 @@ module Apitest
       @default_types
     end
 
-    def general_need(general_need = [])
-      return @general_need if general_need.blank?
-      @general_need = {}
-      general_need.each do |need|
-        @general_need[need] = { text: need.to_s , required: true }
+    def public_required(public_required = [])
+      return @public_required if public_required.blank?
+      @public_required = []
+      public_required.each do |need|
+        n = { need => {required: true }}
+        @public_required.push n
       end
-      @general_need
+      @public_required
     end
 
     def start_server_log_listen

metadata

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