minitest_openapi_examples 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fbc114b36d03fefeb73291e3409d9bcac4f49766c8de36cd46eb02bbea880576
+  data.tar.gz: 574fcaeafa8ed30be6e96b6835dd2871d46eaab782eb58c00d4ef75071343fe3
+SHA512:
+  metadata.gz: 8d8ea03599aeeb3f03cfbdf377357449308c0a768ad18689956640b144bc057ec8fd2ec9a8ebff8f1a6d6617bc737a3a5c63d7ef29eaa196e5deb3db0a2492e1
+  data.tar.gz: 0a35df0457f06f19d16d32edfab78cadc18ec2de9b31516d38bb03394ddbf3efaa7300f46e2bc13d75a70638632aac6971917a731c0417af89fe3dd132d28451

data/.idea/.gitignore

@@ -0,0 +1,10 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Ignored default folder with query files
+/queries/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

data/.idea/minitest_openapi_examples.iml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/minitest_openapi_examples.iml" filepath="$PROJECT_DIR$/.idea/minitest_openapi_examples.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: disable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+# Keep complete test examples together.
+Metrics/AbcSize:
+  Exclude:
+    - "test/**/*"
+
+Metrics/BlockLength:
+  Exclude:
+    - "test/**/*"
+
+Metrics/ClassLength:
+  Exclude:
+    - "test/**/*"
+
+Metrics/MethodLength:
+  Exclude:
+    - "test/**/*"

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [Unreleased]
+
+## [0.2.0] - 2026-11-04
+
+- Add opt-in CI check mode for OpenAPI examples recorded by Rails request tests.
+- Report the endpoint and example key when a sanitized request or response example is missing or differs from the checked-in spec. Check mode leaves the YAML file untouched.
+- Document how to enable the check in CI.
+
+## [0.1.0] - 2026-03-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at elizabeth.mor324@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Galiia Fattakhova
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,199 @@
+# MinitestOpenapiExamples
+
+MinitestOpenapiExamples records real request and response examples from Rails Minitest request tests, sanitizes unstable or sensitive values, and writes them into an existing OpenAPI spec.
+
+It is designed for teams that already maintain an OpenAPI document and want to keep examples in sync with real test coverage, without switching to RSpec or adopting a large DSL.
+
+## Features
+
+- Record response examples from Rails Minitest request tests
+- Record request body examples for write actions
+- Sanitize tokens, emails, UUIDs, timestamps, and other unstable values
+- Write examples into an existing OpenAPI YAML file
+- Auto-write examples during test runs, if enabled
+- Run sync manually through a Rake task
+
+## Installation
+
+Add the gem to your application's Gemfile:
+
+```ruby
+gem "minitest_openapi_examples", git: "https://github.com/galiyafatt2/minitest_openapi_examples"
+````
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Usage
+
+Configure the gem in your Rails application:
+
+```ruby
+MinitestOpenapiExamples.configure do |config|
+  config.spec_path = Rails.root.join("doc/openapi.yml").to_s
+  config.auto_write = false
+  config.default_content_type = "application/json"
+
+  config.sanitizers = [
+    ->(value) { value.gsub(/Bearer\s+\S+/, "Bearer [FILTERED]") },
+    ->(value) { value.gsub(/\b[\w.%+-]+@[\w.-]+\.\w+\b/, "[FILTERED_EMAIL]") }
+  ]
+end
+```
+
+Include the test helper in your request test base class:
+
+```ruby
+class ActionDispatch::IntegrationTest
+  include MinitestOpenapiExamples::TestHelper
+end
+```
+
+Annotate a test class with OpenAPI endpoint metadata:
+
+```ruby
+class Api::V1::ArticlesTest < ActionDispatch::IntegrationTest
+  openapi_examples path: "/api/v1/articles/{id}", method: :get, operation_id: "getArticle"
+
+  test "shows an article" do
+    article = articles(:published)
+
+    get api_v1_article_path(article), headers: auth_headers
+
+    assert_response :success
+
+    record_openapi_example!(
+      name: "published_article",
+      summary: "Published article response",
+      path_params: { id: article.id }
+    )
+  end
+end
+```
+
+For create or update actions, you can also record a request body example:
+
+```ruby
+class Api::V1::ArticlesTest < ActionDispatch::IntegrationTest
+  openapi_examples path: "/api/v1/articles", method: :post, operation_id: "createArticle"
+
+  test "creates an article" do
+    payload = { title: "Hello" }
+
+    post api_v1_articles_path, params: payload, as: :json
+
+    assert_response :created
+
+    record_openapi_example!(
+      name: "create_article",
+      summary: "Create article request",
+      request_body: payload
+    )
+  end
+end
+```
+
+Recorded examples are written into the matching OpenAPI operation by:
+
+1. `operationId`, if provided
+2. otherwise `path + method`
+
+Response examples are written under:
+
+* `responses.*.content.*.examples`
+
+Request examples are written under:
+
+* `requestBody.content.*.examples`
+
+## Manual Sync
+
+If `auto_write` is disabled, you can write recorded examples manually:
+
+```bash
+bin/rails openapi:examples:write
+```
+
+## Check examples in CI
+
+Enable check mode in your Rails test setup, alongside your existing gem configuration.
+
+```ruby
+MinitestOpenapiExamples.configure do |config|
+  config.check_examples = ENV["OPENAPI_EXAMPLES_CHECK"] == "1"
+end
+```
+
+Run the request tests that call `record_openapi_example!`.
+
+```sh
+OPENAPI_EXAMPLES_CHECK=1 bin/rails test test/integration
+```
+
+Each recording compares its sanitized response and any supplied request body with the corresponding examples in the configured spec. A missing or changed example fails the test and identifies the example and endpoint. Update the checked-in example at that key and rerun the test. Check mode takes precedence over `auto_write` and leaves the spec file untouched.
+
+Use distinct, stable example names within each operation, status, and media type. The check compares the exact key, including any suffix you explicitly pass in `name:`. Examples that your test run doesn't record are outside the check.
+
+## Configuration
+
+The gem supports these configuration options:
+
+* `spec_path` - path to the OpenAPI YAML file
+* `sanitizers` - array of lambdas used to sanitize string values
+* `auto_write` - write examples immediately after recording
+* `check_examples` - compare recorded examples against the spec without writing (default: false)
+* `default_content_type` - fallback content type for request and response examples
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+bin/setup
+bundle exec rake test
+```
+
+You can also use:
+
+```bash
+bin/console
+```
+
+to experiment with the gem locally.
+
+To install this gem onto your local machine, run:
+
+```bash
+bundle exec rake install
+```
+
+## Roadmap
+
+Planned improvements include:
+
+* Better YAML output stability
+* Optional request header example support
+* Rails auto-inclusion for `ActionDispatch::IntegrationTest`
+* Improved duplicate example handling across repeated runs
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub:
+
+[https://github.com/galiyafatt2/minitest_openapi_examples](https://github.com/galiyafatt2/minitest_openapi_examples)
+
+Please make sure changes include tests where appropriate.
+
+## License
+
+This gem is available as open source under the terms of the MIT License.
+
+## Code of Conduct
+
+Everyone interacting in the MinitestOpenapiExamples project is expected to follow the code of conduct:
+
+[https://github.com/galiyafatt2/minitest_openapi_examples/blob/main/CODE_OF_CONDUCT.md](https://github.com/galiyafatt2/minitest_openapi_examples/blob/main/CODE_OF_CONDUCT.md)
+

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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/lib/minitest_openapi_examples/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module MinitestOpenapiExamples
+  # Holds settings for recording, writing, and checking examples.
+  class Configuration
+    attr_accessor :spec_path, :sanitizers, :auto_write, :check_examples, :default_content_type
+
+    def initialize
+      @spec_path = "doc/openapi.yaml"
+      @sanitizers = []
+      @auto_write = false
+      @check_examples = false
+      @default_content_type = "application/json"
+    end
+  end
+end

data/lib/minitest_openapi_examples/example_sync.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MinitestOpenapiExamples
+  # Writes the recorded examples to the configured OpenAPI document.
+  class ExampleSync
+    def initialize(
+      registry: MinitestOpenapiExamples.registry,
+      document: OpenapiDocument.new
+    )
+      @registry = registry
+      @document = document
+      @writer = ExampleWriter.new(document: document)
+    end
+
+    def call
+      registry.all.each do |example|
+        writer.call(example)
+      end
+
+      document.write!
+      registry.clear
+    end
+
+    private
+
+    attr_reader :registry, :document, :writer
+  end
+end

data/lib/minitest_openapi_examples/example_writer.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module MinitestOpenapiExamples
+  # Writes or checks the examples for a recorded request and response.
+  class ExampleWriter
+    def initialize(document:)
+      @document = document
+      @operation_finder = OperationFinder.new(document: document)
+    end
+
+    def call(example, check: false)
+      operation = operation_finder.call(example)
+      raise Error, "OpenAPI operation not found for #{example.http_method.upcase} #{example.path}" unless operation
+
+      write_response_example(operation, example, check: check)
+      write_request_example(operation, example, check: check)
+    end
+
+    private
+
+    attr_reader :document, :operation_finder
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def write_response_example(operation, example, check:)
+      response_node = response_node_for(operation, example.response_code)
+      content_type = example.response_content_type || MinitestOpenapiExamples.configuration.default_content_type
+
+      content_node = response_node["content"] ||= {}
+      media_type_node = content_node[content_type] ||= {}
+      examples_node = media_type_node["examples"] ||= {}
+
+      name = (example.name || default_response_example_name(example)).to_s
+      payload = build_example_payload(summary: example.summary, value: example.response_body)
+      sync_example(examples_node, name, payload, check: check) do
+        endpoint = "#{example.http_method.upcase} #{example.path}"
+        "response example #{name.inspect} for #{endpoint} (#{example.response_code}, #{content_type})"
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def write_request_example(operation, example, check:)
+      return if example.request_body.nil?
+
+      request_body_node = operation["requestBody"] ||= {}
+      content_node = request_body_node["content"] ||= {}
+
+      content_type = MinitestOpenapiExamples.configuration.default_content_type
+      media_type_node = content_node[content_type] ||= {}
+      examples_node = media_type_node["examples"] ||= {}
+
+      name = (example.name || default_request_example_name(example)).to_s
+      payload = build_example_payload(summary: example.summary, value: example.request_body)
+      sync_example(examples_node, name, payload, check: check) do
+        "request example #{name.inspect} for #{example.http_method.upcase} #{example.path} (#{content_type})"
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    def response_node_for(operation, response_code)
+      responses = operation["responses"] ||= {}
+      responses[response_code] ||= { "description" => "Recorded response" }
+    end
+
+    def build_example_payload(summary:, value:)
+      payload = { "value" => value }
+      payload["summary"] = summary if summary
+      payload
+    end
+
+    def sync_example(examples_node, name, payload, check:)
+      if check
+        return if examples_node[name] == payload
+
+        raise Error, "OpenAPI drift in #{yield}. Update the example in #{document.path}."
+      end
+
+      examples_node[next_example_name(examples_node, name)] = payload
+    end
+
+    def next_example_name(examples_node, base_name)
+      return base_name unless examples_node.key?(base_name)
+
+      suffix = 2
+
+      loop do
+        candidate_name = "#{base_name}_#{suffix}"
+        return candidate_name unless examples_node.key?(candidate_name)
+
+        suffix += 1
+      end
+    end
+
+    def default_response_example_name(example)
+      case example.response_code
+      when "200" then "success"
+      when "201" then "created"
+      when "204" then "no_content"
+      when "401" then "unauthorized"
+      when "404" then "not_found"
+      when "422" then "validation_error"
+      else
+        "response_#{example.response_code}"
+      end
+    end
+
+    def default_request_example_name(example)
+      case example.http_method
+      when "post" then "create_request"
+      when "patch" then "update_request"
+      when "put" then "replace_request"
+      else
+        "request"
+      end
+    end
+  end
+end

data/lib/minitest_openapi_examples/openapi_document.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module MinitestOpenapiExamples
+  # Loads and saves the configured OpenAPI YAML document.
+  class OpenapiDocument
+    attr_reader :path, :data
+
+    def initialize(path: MinitestOpenapiExamples.configuration.spec_path)
+      @path = path
+      @data = load_data
+    end
+
+    def write!
+      File.write(path, YAML.dump(data))
+    end
+
+    private
+
+    def load_data
+      return {} unless File.exist?(path)
+
+      YAML.safe_load(File.read(path), aliases: true) || {}
+    end
+  end
+end

data/lib/minitest_openapi_examples/operation_finder.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module MinitestOpenapiExamples
+  # Finds the OpenAPI operation for a recorded example.
+  class OperationFinder
+    def initialize(document:)
+      @document = document
+    end
+
+    def call(example)
+      paths = document.data.fetch("paths", {})
+
+      if example.operation_id
+        operation = find_by_operation_id(paths, example.operation_id)
+        return operation if operation
+      end
+
+      find_by_path_and_method(paths, example.path, example.http_method)
+    end
+
+    private
+
+    attr_reader :document
+
+    def find_by_operation_id(paths, operation_id)
+      paths.each_value do |path_item|
+        path_item.each do |http_method, operation|
+          next unless http_method.is_a?(String)
+          next unless operation.is_a?(Hash)
+          next unless operation["operationId"] == operation_id
+
+          return operation
+        end
+      end
+
+      nil
+    end
+
+    def find_by_path_and_method(paths, path, http_method)
+      path_item = paths[path]
+      return unless path_item.is_a?(Hash)
+
+      path_item[http_method.to_s]
+    end
+  end
+end

data/lib/minitest_openapi_examples/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module MinitestOpenapiExamples
+  # Registers the gem's Rake tasks with Rails.
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path("tasks/minitest_openapi_examples_tasks.rake", __dir__)
+    end
+  end
+end

data/lib/minitest_openapi_examples/recorded_example.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module MinitestOpenapiExamples
+  # Stores request and response data for one OpenAPI example.
+  class RecordedExample
+    attr_reader :path,
+                :http_method,
+                :operation_id,
+                :name,
+                :summary,
+                :path_params,
+                :query_params,
+                :request_body,
+                :response_status,
+                :response_content_type,
+                :response_body
+
+    # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+    def initialize(
+      path:,
+      http_method:,
+      response_status:, response_content_type:, response_body:, operation_id: nil,
+      name: nil,
+      summary: nil,
+      path_params: {},
+      query_params: {},
+      request_body: nil
+    )
+      @path = path
+      @http_method = http_method.to_s
+      @operation_id = operation_id
+      @name = name
+      @summary = summary
+      @path_params = path_params || {}
+      @query_params = query_params || {}
+      @request_body = request_body
+      @response_status = response_status
+      @response_content_type = response_content_type
+      @response_body = response_body
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
+
+    def response_code
+      response_status.to_s
+    end
+  end
+end

data/lib/minitest_openapi_examples/redactor.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module MinitestOpenapiExamples
+  # Applies the configured sanitizers to recorded example data.
+  class Redactor
+    def initialize(sanitizers: MinitestOpenapiExamples.configuration.sanitizers)
+      @sanitizers = Array(sanitizers)
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def call(value)
+      case value
+      when RecordedExample
+        RecordedExample.new(
+          path: value.path,
+          http_method: value.http_method,
+          operation_id: value.operation_id,
+          name: value.name,
+          summary: sanitize_string_or_value(value.summary),
+          path_params: call(value.path_params),
+          query_params: call(value.query_params),
+          request_body: call(value.request_body),
+          response_status: value.response_status,
+          response_content_type: value.response_content_type,
+          response_body: call(value.response_body)
+        )
+      when Hash
+        value.to_h do |key, nested_value|
+          [key, call(nested_value)]
+        end
+      when Array
+        value.map { |nested_value| call(nested_value) }
+      when String
+        sanitize_string(value)
+      else
+        value
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    private
+
+    attr_reader :sanitizers
+
+    def sanitize_string_or_value(value)
+      return value unless value.is_a?(String)
+
+      sanitize_string(value)
+    end
+
+    def sanitize_string(value)
+      sanitizers.reduce(value) do |current_value, sanitizer|
+        sanitizer.call(current_value)
+      end
+    end
+  end
+end

data/lib/minitest_openapi_examples/registry.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MinitestOpenapiExamples
+  # Collects recorded examples before they are written.
+  class Registry
+    def initialize
+      @examples = []
+    end
+
+    def add(example)
+      examples << example
+    end
+
+    def all
+      examples.dup
+    end
+
+    def clear
+      examples.clear
+    end
+
+    private
+
+    attr_reader :examples
+  end
+end

data/lib/minitest_openapi_examples/tasks/minitest_openapi_examples_tasks.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+namespace :openapi do
+  namespace :examples do
+    desc "Write recorded Minitest OpenAPI examples into the configured spec file"
+    task write: :environment do
+      MinitestOpenapiExamples::ExampleSync.new.call
+      puts "Updated OpenAPI examples in #{MinitestOpenapiExamples.configuration.spec_path}"
+    end
+  end
+end

data/lib/minitest_openapi_examples/test_helper.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module MinitestOpenapiExamples
+  # Records examples from Rails integration tests.
+  module TestHelper
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Declares the OpenAPI operation exercised by a test class.
+    module ClassMethods
+      def openapi_examples(path:, method:, operation_id: nil)
+        @openapi_examples_metadata = {
+          path: path,
+          http_method: method.to_s,
+          operation_id: operation_id
+        }
+      end
+
+      def openapi_examples_metadata
+        if instance_variable_defined?(:@openapi_examples_metadata)
+          @openapi_examples_metadata
+        elsif superclass.respond_to?(:openapi_examples_metadata)
+          superclass.openapi_examples_metadata
+        end
+      end
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def record_openapi_example!(
+      name: nil,
+      summary: nil,
+      path_params: {},
+      query_params: {},
+      request_body: nil
+    )
+      metadata = self.class.openapi_examples_metadata
+      raise MinitestOpenapiExamples::Error, "Missing openapi_examples metadata" unless metadata
+
+      example = RecordedExample.new(
+        path: metadata.fetch(:path),
+        http_method: metadata.fetch(:http_method),
+        operation_id: metadata[:operation_id],
+        name: name,
+        summary: summary,
+        path_params: path_params,
+        query_params: query_params,
+        request_body: request_body,
+        response_status: response.status,
+        response_content_type: response.media_type || MinitestOpenapiExamples.configuration.default_content_type,
+        response_body: parsed_response_body
+      )
+
+      sanitized_example = MinitestOpenapiExamples::Redactor.new.call(example)
+
+      configuration = MinitestOpenapiExamples.configuration
+      if configuration.check_examples
+        document = OpenapiDocument.new
+        ExampleWriter.new(document: document).call(sanitized_example, check: true)
+      else
+        MinitestOpenapiExamples.registry.add(sanitized_example)
+        ExampleSync.new.call if configuration.auto_write
+      end
+
+      sanitized_example
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    private
+
+    def parsed_response_body
+      return response.parsed_body if response.respond_to?(:parsed_body)
+
+      response.body
+    end
+  end
+end

data/lib/minitest_openapi_examples/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MinitestOpenapiExamples
+  VERSION = "0.2.0"
+end

data/lib/minitest_openapi_examples.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "minitest_openapi_examples/version"
+require_relative "minitest_openapi_examples/configuration"
+require_relative "minitest_openapi_examples/recorded_example"
+require_relative "minitest_openapi_examples/registry"
+require_relative "minitest_openapi_examples/redactor"
+require_relative "minitest_openapi_examples/test_helper"
+require_relative "minitest_openapi_examples/openapi_document"
+require_relative "minitest_openapi_examples/operation_finder"
+require_relative "minitest_openapi_examples/example_writer"
+require_relative "minitest_openapi_examples/example_sync"
+
+require_relative "minitest_openapi_examples/railtie" if defined?(Rails::Railtie)
+
+# Records Rails integration test examples for OpenAPI documentation.
+module MinitestOpenapiExamples
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    def registry
+      @registry ||= Registry.new
+    end
+
+    def reset_registry!
+      @registry = Registry.new
+    end
+  end
+end

data/minitest_openapi_examples.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/minitest_openapi_examples/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "minitest_openapi_examples"
+  spec.version = MinitestOpenapiExamples::VERSION
+  spec.authors = ["Galiia Fattakhova"]
+  spec.email = ["elizabeth.mor324@gmail.com"]
+
+  spec.summary = "Record OpenAPI examples from Rails Minitest request tests"
+  spec.description = "Captures request and response examples from Rails Minitest integration tests, " \
+                     "redacts unstable values, and writes the examples into an existing OpenAPI spec."
+  spec.homepage = "https://github.com/galiyafatt2/minitest_openapi_examples"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/galiyafatt2/minitest_openapi_examples"
+  spec.metadata["changelog_uri"] = "https://github.com/galiyafatt2/minitest_openapi_examples/blob/main/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 6.1"
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/minitest_openapi_examples.rbs

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

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: minitest_openapi_examples
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Galiia Fattakhova
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: Captures request and response examples from Rails Minitest integration
+  tests, redacts unstable values, and writes the examples into an existing OpenAPI
+  spec.
+email:
+- elizabeth.mor324@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/minitest_openapi_examples.iml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minitest_openapi_examples.rb
+- lib/minitest_openapi_examples/configuration.rb
+- lib/minitest_openapi_examples/example_sync.rb
+- lib/minitest_openapi_examples/example_writer.rb
+- lib/minitest_openapi_examples/openapi_document.rb
+- lib/minitest_openapi_examples/operation_finder.rb
+- lib/minitest_openapi_examples/railtie.rb
+- lib/minitest_openapi_examples/recorded_example.rb
+- lib/minitest_openapi_examples/redactor.rb
+- lib/minitest_openapi_examples/registry.rb
+- lib/minitest_openapi_examples/tasks/minitest_openapi_examples_tasks.rake
+- lib/minitest_openapi_examples/test_helper.rb
+- lib/minitest_openapi_examples/version.rb
+- minitest_openapi_examples.gemspec
+- sig/minitest_openapi_examples.rbs
+homepage: https://github.com/galiyafatt2/minitest_openapi_examples
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/galiyafatt2/minitest_openapi_examples
+  source_code_uri: https://github.com/galiyafatt2/minitest_openapi_examples
+  changelog_uri: https://github.com/galiyafatt2/minitest_openapi_examples/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Record OpenAPI examples from Rails Minitest request tests
+test_files: []