yapi_check 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20968fe1514e86325f979ba7041f82c75db592f74905978e7876644b3d217fd1
+  data.tar.gz: c65b430731996baf54cabe776b6d497933052d7cbcb30fd30728bf2705e2bb13
+SHA512:
+  metadata.gz: 75de9664e3764fb17c641094430000afff2cf1e8a953283dd7c8cba9eba650d090719746f2af0be324f6ae79e457a9cdd0293e98e6c6706b95426c81e81ab490
+  data.tar.gz: f9c0be6dc4b99c10ad8937b72e235b26e942c925e0e60ac91b6e151675fe23e6320c8b2d489187c5cd39746ed12630b2f58a542f4b803e54b57b22e22a949507

data/.rubocop.yml

@@ -0,0 +1,61 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - db/schema.rb
+    - bin/**
+  SuggestExtensions: false
+Style/RedundantReturn:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 150
+Metrics/CyclomaticComplexity:
+  Max: 60
+Metrics/ClassLength:
+  Max: 410
+Metrics/BlockLength:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ParameterLists:
+  Max: 14
+Style/FormatStringToken:
+  Enabled: false
+Style/FormatString:
+  Enabled: false
+Naming/VariableNumber:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
+Metrics/BlockNesting:
+  Max: 4
+Style/CaseLikeIf:
+  Enabled: false
+Lint/SuppressedException:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Lint/DuplicateBranch:
+  Enabled: false
+Style/HashSyntax:
+  Enabled: false
+Style/WordArray:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Released]
+
+## [1.0.0] - 2024-03-13
+
+Release first version.

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yapi_check.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'minitest', '~> 5.0'
+
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -0,0 +1,242 @@
+PATH
+  remote: .
+  specs:
+    yapi_check (1.0.0)
+      http (>= 3.0)
+      method_source (~> 1.0)
+      rails (>= 5.2)
+      railties (>= 4.0)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.3.2)
+      actionview (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      globalid (>= 0.3.6)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      timeout (>= 0.4.0)
+    activestorage (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      marcel (~> 1.0)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    builder (3.2.4)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
+    domain_name (0.6.20240107)
+    drb (2.2.1)
+    erubi (1.12.0)
+    ffi (1.16.3)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    http (5.2.0)
+      addressable (~> 2.8)
+      base64 (~> 0.1)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.5.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    i18n (1.14.3)
+      concurrent-ruby (~> 1.0)
+      racc (~> 1.7)
+    io-console (0.7.2)
+    irb (1.11.2)
+      rdoc
+      reline (>= 0.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    llhttp-ffi (0.5.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    minitest (5.22.2)
+    mutex_m (0.2.0)
+    net-imap (0.4.10)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0.1)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.16.2-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rack (3.0.9.1)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.3.2)
+      actioncable (= 7.1.3.2)
+      actionmailbox (= 7.1.3.2)
+      actionmailer (= 7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actiontext (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      bundler (>= 1.15.0)
+      railties (= 7.1.3.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.0)
+    reline (0.4.3)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.1)
+      parser (>= 3.3.0.4)
+    ruby-progressbar (1.13.0)
+    stringio (3.1.0)
+    thor (1.3.1)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.13)
+
+PLATFORMS
+  x86_64-darwin
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  yapi_check!
+
+BUNDLED WITH
+   2.5.6

data/README.md

@@ -0,0 +1,114 @@
+# YapiCheck
+
+[en](./README.md) | [zh-CN](./README.zh-CN.md)
+
+> YAPI is an excellent tool for managing API documentation, but maintaining consistency between the API documentation and code can be challenging. Instead of relying on manual recognition, let this tool automate the process for you.
+
+This is a tool for checking the consistency and conformity between YAPI API documentation and code, ensuring strong consistency and adherence to standards.
+
+## Key Features
+
+### 1. Request Parameter Check
++ Scans the source code of actions, captures the lucky_param parameters of actions, and matches them with the input metadata of YAPI documentation.
+  + Supports mandatory and optional validation
+  + JSON parameters support type validation, including String, Float, and Integer types
+  + Parameter checks require each field to be on a separate line, like:
+    ```ruby
+      required(:name, :String) # Name
+      required(:phone, :Integer) # Phone number
+      required(:height, :Float) # Height
+      optional(:email, :Email) # Email
+      optional(:tags, :ArrayJSON) # Tags
+    ```
+### 2. Response Parameter Check
++ Matches Jbuilder source code with the output metadata of YAPI documentation.
+  + Supports sub-views
+  + Supports paths relative to the root directory or the current file directory
+  + Action names must match the Jbuilder file names
+  + Output requires each returned field to be on a separate line
+  + Output requires mandatory type conversion:
+    + Strings: Recognized using to_s, json.attr_name ... to_s
+    + Integers: Recognized using to_i, json.attr_name ... to_i
+    + Floats: Recognized using to_f, json.attr_name ... to_f
+    + Arrays: Recognized using to_a or do, json.attr_name ... each do
+    + Hashes: Recognized using to_h or do, json.attr_name each do
+  ```ruby
+  json.user do
+    json.name   user.name.to_s
+    json.phone  user.phone.to_i
+    json.height user.height.to_f
+    json.email  user.email.to_s
+    json.tags   user.tags.to_a
+  end
+  ```
+  + Does not support boolean types; use integers instead
+  + Attributes must be included in the data object, such as: {"code":200, "data":{}}
+### 3. Batch Check
++ Supports checking all interfaces of a single project
++ Supports checking a single interface
++ Supports checking interfaces under a single tag
+
+## Usage Instructions
+
+1. Add the following line to your Rails project's Gemfile:
+
+```ruby
+gem 'yapi_check'
+```
+
+2. Run bundle install:
+
+```shell
+$ bundle install
+```
+
+3. Insert the following code into your project's Rakefile:
+
+```ruby
+require 'yapi_check/tasks'
+ENV['YAPI_PROJECT_TOKEN'] = 'THE_TOKEN_FROM_YOUR_YAPI_PROJECT' # YAPI project unique identifier (required), recommended to configure in the project. You can find this token in the YAPI project settings.
+ENV['YAPI_PROJECT_DOMAIN'] = 'http://YOUR_YAPI_WEBSITE' # YAPI project domain, recommended to configure on your local machine to avoid changes in ~/.bashrc or ~/.zshrc
+ENV['YAPI_API_PREFIX'] = '' # YAPI project API prefix, can be set to '', defaults to /api/v1 if not set
+```
+
+4. Run YAPI check:
+Note: If using zsh, install the rake plugin in ~/.zshrc to support special syntax plugins=(... rake)
+
+```shell
+# Full check
+$ bundle exec rake yapi:check
+# or
+$ rails yapi:check
+
+# Check a single interface
+$ bundle exec rake yapi:check[/healthy_lives/exit_healthy_life]
+# or
+$ noglob rails yapi:check[/healthy_lives/exit_healthy_life]
+# or
+$ rails 'yapi:check[/healthy_lives/exit_healthy_life]'
+
+# Check a single tag
+$ bundle exec rake yapi:check[,3.3.0]
+# or
+$ noglob rails yapi:check[,3.3.0]
+# or
+$ rails 'yapi:check[,3.3.0]'
+```
+
+## Notes
+
+This tool is only for Rails projects. Request parameter checks heavily depend on [lucky_param](https://github.com/shootingfly/lucky_param), and response parameter checks heavily depend on [Jbuilder](https://github.com/rails/jbuilder).
+
+## Contributing
+
+1. Fork it ( https://github.com/shootingfly/yapi_check/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Make your changes
+4. Run `ruby test/yapi_check_test.rb` to run the tests
+5. Commit your changes (git commit -am 'Add some feature')
+6. Push to the branch (git push origin my-new-feature)
+7. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/README.zh-CN.md

@@ -0,0 +1,110 @@
+# YapiCheck
+
+[en](./README.md) | [zh-CN](./README.zh-CN.md)
+
+> YAPI是一款非常棒的接口文档管理工具, 但保持接口文档与代码一致性是一个难题, 与其通过人眼识别, 不如让工具自动化帮你处理
+
+这是一款用于核对YAPI接口文档与代码的工具, 具有强一致性与规范性.
+
+## 主要功能
+### 1. 请求参数检查
++ 通过扫描action的源代码,并捕获action的lucky_param参数,与YAPI文档的入参元数据进行匹配
+  + 支持必填性与非必填性验证
+  + 其中JSON参数支持类型验证, 支持判断String, Float, Integer三种类型
+  + 参数检测要求每个字段都单独成行, 如
+    ```ruby
+      required(:name, :String) # 姓名
+      required(:phone, :Integer) # 手机号
+      required(:height, :Float) # 身高
+      optional(:email, :Email) # 邮箱
+      optional(:tags, :ArrayJSON) # 标签
+    ```
+### 2. 响应参数检查
++ 通过扫描jbuilder源码,与YAPI文档的出参元数据进行匹配
+  + 支持子视图
+  + 支持使用相对根目录或相对当前文件目录的路径
+  + action名称必须与jbuilder文件名保持一致
+  + 出参要求每个返回的字段都单独成行
+  + 出参要求强制类型转化:
+    + 字符串: 使用to_s识别, json.attr_name ... to_s识别
+    + 整型: 使用to_i识别, json.attr_name ... to_i识别
+    + 浮点数: 使用to_f识别, json.attr_name ... to_f识别
+    + 数组: 使用to_a识别或do识别, json.attr_name ... each do识别
+    + 字典: 使用to_h识别或do识别, json.attr_name each do识别
+  ```ruby
+  json.user do
+    json.name   user.name.to_s
+    json.phone  user.phone.to_i
+    json.height user.height.to_f
+    json.email  user.email.to_s
+    json.tags   user.tags.to_a
+  end
+  ```
+  + 不支持布尔型, 请用整型代替
+  + 属性必须包含在data对象中,如:{"code":200, "data":{}}
+### 3. 批量检查
++ 支持检查单个项目的所有接口
++ 支持仅检查单个接口
++ 支持仅检查单个标签下的接口
+
+## 使用说明
+
+1. 添加本行在Rails项目的Gemfile中
+
+```ruby
+gem 'yapi_check'
+```
+
+2. 执行bundle install
+```shell
+$ bundle install
+```
+
+3. 在项目的Rakefile中间插入如下代码
+```ruby
+require 'yapi_check/tasks'
+ENV['YAPI_PROJECT_TOKEN'] = 'THE_TOKEN_FROM_YOUR_YAPI_PROJECT' # YAPI项目唯一标识(必填), 建议配置在项目里. 该配置可进入YAPI项目查看并拷贝, 功能路径: 设置 -> token配置
+ENV['YAPI_PROJECT_DOMAIN'] = 'http://YOUR_YAPI_WEBSITE' # YAPI项目域名, 建议配置在个人电脑里, 避免变更 ~/.bashrc or ~/.zshrc
+ENV['YAPI_API_PREFIX'] = '' # YAPI项目接口前缀, 可设置为'', 不设置默认为/api/v1
+```
+
+4. 执行YAPI检查
+注: 若使用zsh, 请于~/.zshrc中安装rake插件以支持特殊语法 plugins=(... rake)
+
+```shell
+# 完整检查
+$ bundle exec rake yapi:check
+# or
+$ rails yapi:check
+
+# 单个接口检查
+$ bundle exec rake yapi:check[/healthy_lives/exit_healthy_life]
+# or
+$ noglob rails yapi:check[/healthy_lives/exit_healthy_life]
+# or
+$ rails 'yapi:check[/healthy_lives/exit_healthy_life]'
+
+# 单个标签检查
+$ bundle exec rake yapi:check[,3.3.0]
+# or
+$ noglob rails yapi:check[,3.3.0]
+# or
+$ rails 'yapi:check[,3.3.0]'
+```
+
+## 注意事项
+本工具仅限Rails项目使用, 请求参数检查强依赖[lucky_param](https://github.com/shootingfly/lucky_param), 响应参数检查强依赖[jbuilder](https://github.com/rails/jbuilder)
+
+## 贡献
+
+1. Fork它 ( https://github.com/shootingfly/yapi_check/fork )
+2. 创建一个新的功能分支 (git checkout -b my-new-feature)
+3. 进行你的更改
+4. 运行 `ruby test/yapi_check_test.rb` 来运行测试
+5. 提交你的更改 (git commit -am 'Add some feature')
+6. 推送到分支 (git push origin my-new-feature)
+7. 创建一个新的Pull请求
+
+## 许可证
+
+该Gem以[MIT许可证](https://opensource.org/licenses/MIT)的形式提供。

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'yapi_check'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yapi_check/config.rb

@@ -0,0 +1,18 @@
+module YapiCheck
+  class Config
+    # YAPI项目令牌
+    def self.yapi_project_token
+      ENV.fetch('YAPI_PROJECT_TOKEN', nil)
+    end
+
+    # YAPI项目开放API访问域名
+    def self.yapi_project_domain
+      ENV.fetch('YAPI_PROJECT_DOMAIN', nil)
+    end
+
+    # 接口统一前缀, 默认为/api/v1
+    def self.yapi_api_prefix
+      ENV.fetch('YAPI_API_PREFIX', '/api/v1')
+    end
+  end
+end

data/lib/yapi_check/executor.rb

@@ -0,0 +1,241 @@
+module YapiCheck
+  class Executor
+    # 当前支持检查的YAPI请求参数类型
+    YAPI_PARAMS_CLASS = {
+      'string' => :String,
+      'number' => :Float,
+      'integer' => :Integer
+    }.freeze
+
+    # 获取YAPI参数
+    def self.get_yapi_params(detail)
+      yapi_params = []
+      form_params = Array(detail['req_body_form'])
+      form_params.each do |form|
+        s = YapiParams.new
+        s.name = form['name']
+        s.example = form['example']
+        s.desc = form['desc']
+        s.required = form['required'].to_i
+        s.category = 'form'
+        yapi_params << s
+      end
+      query_params = Array(detail['req_query'])
+      query_params.each do |query|
+        s = YapiParams.new
+        s.name = query['name']
+        s.example = query['example']
+        s.desc = query['desc']
+        s.required = query['required'].to_i
+        s.category = 'query'
+        yapi_params << s
+      end
+      exist_key_arr = []
+      begin
+        json_data = JSON.parse(detail['req_body_other'] || '{}')
+      rescue JSON::ParserError => e
+        puts "=== 解析json_data JSON出错#{e.backtrace}"
+        return yapi_params
+      end
+      # 先遍历必填项
+      json_params = json_data['required'] || {}
+      json_params.each do |param_name|
+        s = YapiParams.new
+        s.name = param_name
+        s.required = 1
+        s.type = json_data['properties'][param_name]['type']
+        s.category = 'json'
+        exist_key_arr << param_name
+        yapi_params << s
+      end
+      if json_data['properties'].present?
+        json_data['properties'].each do |k, v|
+          next if exist_key_arr.include?(k)
+
+          s = YapiParams.new
+          s.name = k
+          s.type = v['type']
+          s.category = 'json'
+          s.required = 0
+          yapi_params << s
+        end
+      end
+      yapi_params
+    end
+
+    # 获取响应参数
+    def self.get_response_params(detail)
+      yapi_params = []
+      begin
+        json_params = JSON.parse(detail['res_body'] || '{}')['properties']['data']['properties'] || {}
+      rescue JSON::ParserError => e
+        puts "=== 解析json_params JSON出错#{e.backtrace}"
+        return []
+      end
+      json_params.each do |k, v|
+        s = YapiParams.new
+        s.name = k
+        s.type = v['type']
+        s.category = 'json'
+        yapi_params << s
+        properties = nil
+        case v['type']
+        when 'object'
+          properties = v['properties']
+        when 'array'
+          properties = v['items']['properties']
+        end
+        next unless properties.present?
+
+        properties.each do |sk, sv|
+          s = YapiParams.new
+          s.name = sk
+          s.type = sv['type']
+          s.category = 'json'
+          yapi_params << s
+        end
+      end
+      yapi_params
+    end
+
+    # 获取Rails控制器和动作
+    def self.get_controller_and_action(endpoint, method)
+      request_controller_and_action = Rails.application.routes.recognize_path(endpoint, method: method)
+      controller = "#{request_controller_and_action[:controller]}_controller".classify.constantize
+      action = request_controller_and_action[:action].to_sym
+      [controller, action]
+    rescue ActionController::RoutingError
+      []
+    end
+
+    # 检查请求参数是否正确(json支持检查类型, query和form不支持)
+    def self.check_request_params(_method, yapi_params, action_source)
+      errors = []
+      yapi_params.each do |yapi_param|
+        # 必填性验证
+        required_check = yapi_param.required == 1 ? "required(:#{yapi_param.name}" : "optional(:#{yapi_param.name}"
+        errors << "#{yapi_param.name}必填性错误，期待#{required_check}" unless action_source.include?(required_check)
+        # 类型验证
+        if yapi_param.category == 'json'
+          type_errors = get_must_not_in_strings(yapi_param).select { |x| action_source.include?(x) }
+          errors << "#{yapi_param.name}类型错误, 期待#{required_check}, #{YAPI_PARAMS_CLASS[yapi_param.type]}}" unless type_errors.empty?
+        end
+      end
+
+      errors
+    end
+
+    # 反向匹配参数类型
+    def self.get_must_not_in_strings(yapi_param)
+      name = yapi_param.name
+      case yapi_param.type
+      when 'string' then ["#{name}, :Integer)", "#{name}, :Float)"]
+      when 'number' then ["#{name}, :String)", "#{name}, :Integer)"]
+      when 'integer' then ["#{name}, :String)", "#{name}, :Float)"]
+      else
+        []
+      end
+    end
+
+    # 检查接口名称是否一致
+    def self.check_request_title(action_title, yapi_title)
+      errors = []
+      errors << action_title unless action_title == yapi_title
+      errors
+    end
+
+    # 核对响应
+    def self.check_response(response_params, jbuilder_source)
+      errors = []
+      response_params.each do |response_param|
+        errors << response_param.name unless jbuilder_source =~ get_response_param_type(response_param.name, response_param.type)
+      end
+      errors
+    end
+
+    # 获取响应参数对应的类型(正则表达式)
+    def self.get_response_param_type(name, type)
+      case type
+      when 'string' then /json\.#{name}\s.*\.to_s/
+      when 'number' then /json\.#{name}\s.*\.to_f/
+      when 'integer' then /json\.#{name}\s.*\.to_i/
+      when 'array' then /json\.#{name}\s(.*\.to_a|.*\sdo)/
+      when 'object' then /json\.#{name}\s(.*\.to_h|do\s)/
+      else
+        raise "Unknown parameter type: #{type}"
+      end
+    end
+
+    # 检查单个接口
+    def self.check_single_interface(interface_id, method_mapping, path_mapping)
+      params = {
+        token: YapiCheck::Config.yapi_project_token,
+        id: interface_id
+      }
+      response = HTTP.get("#{YapiCheck::Config.yapi_project_domain}/api/interface/get", params: params)
+      begin
+        detail = JSON.parse(response.body)['data'].to_h
+      rescue JSON::ParserError => e
+        puts "=== 解析detail JSON出错#{e.backtrace}"
+        return
+      end
+      endpoint = "#{YapiCheck::Config.yapi_api_prefix}#{path_mapping[interface_id]}"
+      controller, action = get_controller_and_action(endpoint, method_mapping[interface_id])
+      unless controller.respond_to?(:instance_method)
+        puts "=== #{endpoint} 接口未实现"
+        return
+      end
+      action_source = controller.instance_method(action).source
+      error = {}
+      response_params = get_response_params(detail)
+      begin
+        if response_params.present?
+          jbuilder_source = expand_jbuilder_with_partial("#{YapiCheck::Config.yapi_api_prefix}#{path_mapping[interface_id]}.json.jbuilder")
+          error[:response_error] = check_response(response_params, jbuilder_source)
+        end
+      rescue StandardError => e
+        puts e
+        puts "=== #{path_mapping[interface_id]} 接口所在目录中缺少的jbuilder文件, 请判断是否需要添加对应jbuilder文件 ==="
+      end
+      yapi_params = get_yapi_params(detail)
+      endpoint_error = {}
+      error[:request_params_error] = check_request_params(method_mapping[interface_id], yapi_params, action_source)
+      endpoint_error["#{method_mapping[interface_id]} #{path_mapping[interface_id]}"] = error if error[:request_params_error].present? || error[:response_error].present?
+      if endpoint_error.present?
+        puts "接口: #{path_mapping[interface_id]} 对应文档中的请求参数或响应参数与当前代码存在不一致,"
+        puts "请求参数不同之处: #{error[:request_params_error]}"
+        puts "响应参数不同之处: #{error[:response_error]}"
+      else
+        puts "=== 请求类型: #{method_mapping[interface_id]}, 接口: #{path_mapping[interface_id]} 检查无误 ==="
+      end
+    end
+
+    # 使用子视图展开jbuilder(递归)
+    def self.expand_jbuilder_with_partial(jbuilder_file_name, parent_file_name = nil)
+      parent_file_name ||= jbuilder_file_name # 若是相对路径需要知道父级的文件名
+      jbuilder_source = []
+      jbuilder_view_path = File.join('app/views', jbuilder_file_name)
+      File.open(jbuilder_view_path) do |file|
+        file.each_line(chomp: true) do |line|
+          if line =~ %r{json\.partial! '([a-z0-9_/]+)'}
+            partial_file_name = Regexp.last_match(1)
+            partial_file_name_arr = partial_file_name.split('/')
+            if partial_file_name_arr.size == 1
+              # 相对路径 base_measurement => api/v1/measurements/_base_measurement
+              partial_view_name = File.join(File.dirname(parent_file_name), "_#{partial_file_name}")
+            else
+              # 绝对路径 api/v1/measurements/base_measurement => api/v1/measurements/_base_measurement
+              partial_file_name_arr[-1] = "_#{partial_file_name_arr[-1]}"
+              partial_view_name = partial_file_name_arr.join('/')
+            end
+            jbuilder_source << expand_jbuilder_with_partial("#{partial_view_name}.json.jbuilder", parent_file_name)
+          else
+            jbuilder_source << line
+          end
+        end
+      end
+
+      jbuilder_source.join("\n")
+    end
+  end
+end

data/lib/yapi_check/tasks.rb

@@ -0,0 +1,67 @@
+require_relative '../yapi_check'
+
+desc 'YAPI检查'
+namespace :yapi do
+  task :check, %i[uri version] => :environment do |_task, args|
+    raise '请设置YAPI_PROJECT_TOKEN环境变量 ' if YapiCheck::Config.yapi_project_token.nil?
+    raise '请设置YAPI_PROJECT_DOMAIN环境变量 ' if YapiCheck::Config.yapi_project_domain.nil?
+
+    puts "\n=== 开启YAPI接口检查(注意: 接口若使用非json参数, 则无法核对参数类型) ===\n"
+    # 获取接口列表
+    params = {
+      token: YapiCheck::Config.yapi_project_token,
+      page: 1,
+      limit: 1000
+    }
+    response = HTTP.get("#{YapiCheck::Config.yapi_project_domain}/api/interface/list", params: params)
+    interfaces = Array(JSON.parse(response.body).dig('data', 'list'))
+    interface_mapping = {}
+    method_mapping = {}
+    tag_mapping = {}
+    path_mapping = {}
+    interfaces.each do |interface|
+      interface_id = interface['_id']
+      method = interface['method']
+      path = interface['path']
+      tags = interface['tag']
+      method_mapping[interface_id] = method
+      path_mapping[interface_id] = path
+      interface_mapping[path] = interface_id
+      # 根据访问路径check某个API
+      if args[:uri].present?
+        if interface_mapping[args[:uri]].nil?
+          next
+        else
+          YapiCheck::Executor.check_single_interface(interface_mapping[args[:uri]], method_mapping, path_mapping)
+          puts "\n"
+        end
+
+        break
+      end
+      tags.each do |tag|
+        if tag_mapping.key?(tag)
+          tag_mapping[tag] << interface_id
+        else
+          tag_mapping[tag] = [interface_id]
+        end
+      end
+      # 版本号和URI均不传，检查除[接口说明]内容外的所有接口
+      if args[:version].blank? && args[:uri].blank?
+        if interface['title'].start_with?('[接口说明]')
+          next
+        else
+          YapiCheck::Executor.check_single_interface(interface_id, method_mapping, path_mapping)
+          puts "\n"
+        end
+      end
+    end
+    # 根据版本check某些API
+    if args[:version].present? && !tag_mapping[args[:version]].nil?
+      interface_ids = tag_mapping[args[:version]]
+      interface_ids.each do |interface_id|
+        YapiCheck::Executor.check_single_interface(interface_id, method_mapping, path_mapping)
+        puts "\n"
+      end
+    end
+  end
+end

data/lib/yapi_check/version.rb

@@ -0,0 +1,3 @@
+module YapiCheck
+  VERSION = '1.0.0'.freeze
+end

data/lib/yapi_check/yapi_params.rb

@@ -0,0 +1,5 @@
+module YapiCheck
+  class YapiParams
+    attr_accessor :name, :type, :example, :desc, :required, :category
+  end
+end

data/lib/yapi_check.rb

@@ -0,0 +1,12 @@
+require 'method_source'
+require 'http'
+
+require_relative 'yapi_check/executor'
+require_relative 'yapi_check/config'
+require_relative 'yapi_check/version'
+require_relative 'yapi_check/yapi_params'
+
+module YapiCheck
+  class Error < StandardError
+  end
+end

data/sig/yapi_check.rbs

@@ -0,0 +1,4 @@
+module YapiCheck
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: yapi_check
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- KlayHU
+- Shootingfly
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: |2
+      YapiCheck is a gem that automates the process of checking the consistency and conformity between YAPI API documentation and Rails code.
+      It includes features for validating request and response parameters, supporting batch checks, and more.
+email:
+- hudongrui_klay@163.com
+- 790174750@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- README.zh-CN.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yapi_check.rb
+- lib/yapi_check/config.rb
+- lib/yapi_check/executor.rb
+- lib/yapi_check/tasks.rb
+- lib/yapi_check/version.rb
+- lib/yapi_check/yapi_params.rb
+- sig/yapi_check.rbs
+homepage: https://github.com/shootingfly/yapi_check
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/shootingfly/yapi_check.git
+  rubygems_mfa_required: 'true'
+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.5.6
+signing_key:
+specification_version: 4
+summary: A tool for checking consistency between YAPI API documentation and Rails
+  code.
+test_files: []