meta-api 0.0.1

data/lib/meta/route_dsl/uniformed_params_builder.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Meta
+  module RouteDSL
+    class UniformedParamsBuilder
+      def initialize(&block)
+        @parameters = {}
+        @request_body_builder = JsonSchema::ObjectSchemaBuilder.new
+
+        instance_exec &block if block_given?
+      end
+
+      def param(name, options = {}, &block)
+        options = options.dup
+        op_in = options.delete(:in) || 'body'
+
+        if op_in == 'body'
+          property name, options, &block
+        else
+          @parameters[name] = { in: op_in, schema: JsonSchema::BaseSchema.new(options) }
+        end
+      end
+
+      def property(name, options = {}, &block)
+        @request_body_builder.property name, options, &block
+      end
+
+      def build
+        request_body = @request_body_builder.to_schema
+        [@parameters, request_body.properties.empty? ? nil : request_body]
+      end
+    end
+  end
+end

data/lib/meta/swagger_doc.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Meta
+  module SwaggerDocUtil
+    class << self
+      def generate(application, info: {}, servers: [])
+        routes = get_paths_and_routes!(application)
+
+        schemas = {}
+        paths = routes.group_by { |path, route| path }.map { |path, routes| [path, routes.map { |item| item[1] }]}.map do |path, routes|
+          operations = routes.map do |route|
+            [route.method.downcase.to_sym, generate_operation_object(route, schemas)]
+          end.to_h
+
+          # path 需要规范化
+          path = path.gsub(/[:*](\w+)/, '{\1}')
+          [path, operations]
+        end.to_h
+
+        doc = {
+          openapi: '3.0.0',
+          info: info,
+          servers: servers,
+          paths: paths
+        }
+        doc[:components] = { schemas: schemas } unless schemas.empty?
+        doc
+      end
+
+      # 生成单个路由的文档
+      def generate_operation_object(route, schemas)
+        route.meta.generate_operation_doc(schemas)
+      end
+
+      private
+
+      # 获取所有路径和路由对象的映射关系，返回的形式是：
+      #
+      #     [
+      #       ['/foo', route1],
+      #       ['/foo', route2],
+      #       ['/bar', route3],
+      #       ['/bar', route4],
+      #     ]
+      def get_paths_and_routes!(application, prefix = '', store_routes = [])
+        if (application.is_a?(Class) && application < Application) || application.is_a?(Application)
+          prefix = RouteDSL::Helpers.join_path(prefix, application.prefix)
+          (application.routes + application.applications).each do |mod|
+            get_paths_and_routes!(mod, prefix, store_routes)
+          end
+        elsif application.is_a?(Route)
+          route = application
+          route_path = route.path == :all ? prefix : RouteDSL::Helpers.join_path(prefix, route.path)
+          store_routes << [route_path, route] unless route.method == :all
+        else
+          raise "Param application must be a Application instance, Application module or a Route instance, but it got a `#{application}`"
+        end
+
+        store_routes
+      end
+    end
+
+    class Path
+      def initialize(parts = [])
+        @parts = parts.freeze
+      end
+
+      def append(part)
+        part = part[1..-1] if part.start_with?('/')
+        parts = part.split('/')
+
+        self.class.new(@parts + parts)
+      end
+
+      def to_s
+        '/' + @parts.join('/')
+      end
+
+      def self.from_string(path)
+        path = path[1..-1] if path.start_with?('/')
+        parts = path.split('/')
+        self.class.new(parts)
+      end
+    end
+  end
+end

data/lib/meta/utils/path.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Meta
+  module Utils
+    class Path
+      class << self
+        def normalize_path(path)
+          path = '/' unless path
+          path = '/' + path unless path.start_with?('/')
+          path = path.delete_suffix('/') if path.end_with?('/')
+          path
+        end
+
+        def join(p1, p2)
+          normalize_path(normalize_path(p1) + '/' + normalize_path(p2))
+        end
+      end
+    end
+  end
+end

data/meta-api.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |spec|
+  spec.name          = "meta-api"
+  spec.version       = "0.0.1"
+  spec.authors       = ["yetrun"]
+  spec.email         = ["yetrun@foxmail.com"]
+
+  spec.summary       = "一个 Web API 框架"
+  spec.description   = "一个 Web API 框架，该框架采用定义元信息的方式编写 API，并同步生成 API 文档"
+  spec.homepage      = "https://github.com/yetrun/web-frame"
+  spec.license       = "LGPL-2.1"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/yetrun/web-frame.git"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: meta-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- yetrun
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-02 00:00:00.000000000 Z
+dependencies: []
+description: 一个 Web API 框架，该框架采用定义元信息的方式编写 API，并同步生成 API 文档
+email:
+- yetrun@foxmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".autoenv.zsh"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/locales/zh-CN.yml
+- docs/名称由来.md
+- docs/教程.md
+- docs/索引.md
+- examples/lobster.rb
+- examples/rack_app/README.md
+- examples/rack_app/config.ru
+- examples/rack_app/hello.rb
+- examples/rack_app/timing.rb
+- lib/meta/api.rb
+- lib/meta/application.rb
+- lib/meta/application/application.rb
+- lib/meta/application/execution.rb
+- lib/meta/application/meta.rb
+- lib/meta/application/path_matching_mod.rb
+- lib/meta/application/route.rb
+- lib/meta/entity.rb
+- lib/meta/errors.rb
+- lib/meta/json_schema/builders/array_schema_builder.rb
+- lib/meta/json_schema/builders/object_schema_builder.rb
+- lib/meta/json_schema/builders/schema_builder_tool.rb
+- lib/meta/json_schema/schemas.rb
+- lib/meta/json_schema/schemas/array_schema.rb
+- lib/meta/json_schema/schemas/base_schema.rb
+- lib/meta/json_schema/schemas/object_schema.rb
+- lib/meta/json_schema/support/errors.rb
+- lib/meta/json_schema/support/presenters.rb
+- lib/meta/json_schema/support/schema_options.rb
+- lib/meta/json_schema/support/type_converter.rb
+- lib/meta/json_schema/support/validators.rb
+- lib/meta/load_i18n.rb
+- lib/meta/route_dsl/action_builder.rb
+- lib/meta/route_dsl/application_builder.rb
+- lib/meta/route_dsl/chain_builder.rb
+- lib/meta/route_dsl/helpers.rb
+- lib/meta/route_dsl/meta_builder.rb
+- lib/meta/route_dsl/parameters_builder.rb
+- lib/meta/route_dsl/route_builder.rb
+- lib/meta/route_dsl/uniformed_params_builder.rb
+- lib/meta/swagger_doc.rb
+- lib/meta/utils/path.rb
+- meta-api.gemspec
+homepage: https://github.com/yetrun/web-frame
+licenses:
+- LGPL-2.1
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/yetrun/web-frame
+  source_code_uri: https://github.com/yetrun/web-frame.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: 一个 Web API 框架
+test_files: []