Merge pull request #35 from zhandao/v2

Author: zhandao

README.md

@@ -359,11 +359,11 @@
 
 
   # method signature
-  # `exp_by` (select_example_by): choose the example fields.
-  examples(exp_by = :all, examples_hash)
+  # `exp_params` (select_example_by): choose the example fields.
+  examples(exp_params = :all, examples_hash)
   # usage
   # it defines 2 examples by using parameter :id and :name
-  # if pass :all to `exp_by`, keys will be all the parameter's names.
+  # if pass :all to `exp_params`, keys will be all the parameter's names.
   examples [:id, :name], {
       :right_input => [ 1, 'user'], # == { id: 1, name: 'user' }
       :wrong_input => [ -1, ''   ]
@@ -425,7 +425,7 @@
       :password! => { type: String, pattern: /[0-9]{6,10}/, desc: 'password' },
       # optional
         :remarks => { type: String, desc: 'remarks' },
-  }, exp_by:            %i[ name password ],
+  }, exp_params:            %i[ name password ],
      examples: {         #    ↓        ↓
          :right_input => [ 'user1', '123456' ],
          :wrong_input => [ 'user2', 'abc'    ]
@@ -448,7 +448,7 @@
 
   1. `media_type`: we provide some [mapping](lib/oas_objs/media_type_obj.rb) from symbols to real media-types.
   2. `schema_info`: as above (see param).
-  3. `exp_by` and `examples`: for the above example, the following has the same effect:
+  3. `exp_params` and `examples`: for the above example, the following has the same effect:
      ```
      examples: {
          :right_input => { name: 'user1', password: '123456' },

README_zh.md

@@ -1,25 +1,23 @@
 require 'open_api'
 
-OpenApi::Config.tap do |c|
+OpenApi::Config.class_eval do
   # Config DSL
-  c.instance_eval do
-    open_api :zero_rails, base_doc_classes: [ApiDoc]
-    info version: '0.0.1', title: 'Zero Rails APIs', description: 'API documentation of Zero-Rails Application.'
-    server 'http://localhost:3000', desc: 'Main (production) server'
-    server 'http://localhost:3000', desc: 'Internal staging server for testing'
-    bearer_auth :Token
-    global_auth :Token
-  end
+  open_api :zero_rails, base_doc_classes: [ApiDoc]
+  info version: '0.0.1', title: 'Zero Rails APIs', description: 'API documentation of Zero-Rails Application.'
+  server 'http://localhost:3000', desc: 'Main (production) server'
+  server 'http://localhost:3000', desc: 'Internal staging server for testing'
+  bearer_auth :Token
+  global_auth :Token
 
   # [REQUIRED] The location where .json doc file will be output.
-  c.file_output_path = 'public/open_api'
+  self.file_output_path = 'public/open_api'
 
   # [Optional] Use this txt instead of running `rails routes`.
-  # c.rails_routes_file = 'config/routes.txt'
+  # self.rails_routes_file = 'config/routes.txt'
 
   # Everything about OAS3 is on https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md
   # Getting started: https://swagger.io/docs/specification/basic-structure/
-  c.open_api_docs = {
+  self.open_api_docs = {
       blog_api: {
           # [REQUIRED] ZRO will scan all the descendants of the base_doc_classes, then generate their docs.
           base_doc_classes: [ApiController],
@@ -96,9 +94,7 @@
 
 end
 
-Object.const_set('Boolean', 'boolean') # Support `Boolean` writing in DSL
-
-OpenApi.write_docs generate_files: !Rails.env.production?
+OpenApi.write_docs if: !Rails.env.production?
 
 
 __END__

documentation/examples/auto_gen_desc.rb

@@ -19,29 +19,22 @@ def initialize(event_name, http_method, callback_url, &block)
 
       def process
         {
-            self.event_name => {
+            event_name => {
                 processed_url => {
-                    self.http_method.downcase.to_sym => processed_block
+                    http_method.downcase.to_sym => Api.new.run_dsl(&(self.block || -> { }))
                 }
             }
         }
       end
 
       def processed_url
-        self.callback_url.gsub(/{[^{}]*}/) do |exp|
+        callback_url.gsub(/{[^{}]*}/) do |exp|
           key_location, key_name = exp[1..-2].split
           connector = key_location == 'body' ? '#/' : '.'
           key_location = '$request.' + key_location
           ['{', key_location, connector, key_name, '}'].join
         end
       end
-
-      def processed_block
-        api = Api.new.merge! parameters: [ ], requestBody: '', responses: { }
-        api.instance_exec(&(self.block || -> { }))
-        api.process_objs
-        api.delete_if { |_, v| v.blank? }
-      end
     end
   end
 end