For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
预约演示登录免费开始
  • 使用 SDK
    • SDK 概述
    • SDK 如何工作
    • Quickstart
    • Customer showcase
  • 使用 SDK
    • 项目结构
    • 添加自定义代码
    • Migrating to Replay
    • 功能特性
  • 参考
      • Generating an SDK
      • 发布到 RubyGems
      • Ruby 配置
      • 添加自定义代码
      • 变更日志
      • Customer showcase
  • 资源
    • generators.yml
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
预约演示登录免费开始
在本页
  • 2026年6月1日
  • 1.13.1
  • 1.13.0
  • 2026年5月15日
  • 1.12.11
  • 2026年5月14日
  • 1.12.10
  • 2026年5月13日
  • 1.12.9
  • 2026年5月12日
  • 1.12.8
  • 1.12.7
  • 1.12.6
  • 2026年5月7日
  • 1.12.5
  • 1.12.4
  • 2026年5月5日
  • 1.12.3
  • 1.12.2
  • 2026年5月4日
  • 1.12.1
  • 1.12.0
  • 2026年4月29日
  • 1.11.1
  • 1.11.0
  • 1.10.0
  • 2026年4月27日
  • 1.9.0
参考Ruby

Changelog

June 1, 2026
June 1, 2026

May 15, 2026
May 15, 2026

May 14, 2026
May 14, 2026

May 13, 2026
May 13, 2026

May 12, 2026
May 12, 2026

May 7, 2026
May 7, 2026

May 5, 2026
May 5, 2026

May 4, 2026
May 4, 2026

1.12.1

(fix): Fix duplicate root client generation that caused a lint error.

1.12.0

(feat): Generate CONTRIBUTING.md for Ruby SDKs.


April 29, 2026
April 29, 2026

April 27, 2026
April 27, 2026

1.9.0

(feat): 在生成的 Ruby SDK 中支持 x-fern-default 作为参数的回退值。当头部、查询参数或路径参数在 IR 中有 clientDefault 值时,生成的 Ruby SDK 使该参数可选,并自动应用默认值。

较旧的帖子

下一个

1.13.1

(fix): Generated model classes now include fields inherited from parent types (Fern extends / OpenAPI allOf). Previously, derived models — including discriminated union variants — only carried their own declared properties and silently dropped fields contributed by their parents, leaving deserialized responses without id, name, and other inherited common fields.

1.13.0

(feat): Add a max_retries: keyword argument to the generated root Client constructor. Consumers can now configure the default retry count once at client construction (e.g. Client.new(max_retries: 5)) instead of relying on the generation-time maxRetries setting in generators.yml. The constructor default still respects the configured value (or 2 when unset), so existing behavior is preserved.

1.12.11

(fix): Dynamic snippets now render path-parameter arguments in IR (URL / SDK signature) order rather than in the order they happen to appear in the input request, so generated examples line up with the actual SDK method signature even when the spec lists path parameters in a different order.

1.12.10

(chore): Bump addressable from 2.8.10 to 2.9.0 in the ruby-v2 SDK generator container to clear CVE-2026-35611 (ReDoS in URI template expansion). Switch the post-install cleanup to gem cleanup so older 2.8.x copies dragged in by rubocop’s dependency graph are dropped from the final image. rexml stays pinned at 3.4.4 (past the 3.3.6 CVE-2024-49761 fix). Also strip the vendored Gemfile.lock files inside cached gems (lint_roller, rbs, typeprof, unicode-emoji) so grype stops reading their pinned rexml / rdoc / addressable versions as installed packages.

1.12.9

(fix): Stop launching WireMock with --global-response-templating in generated wire-test docker-compose.test.yml. Response examples containing literal {{...}} are now served verbatim instead of being passed through WireMock’s Handlebars transformer, which would fail to resolve them as helpers and return 500.

1.12.8

(fix): Fix Layout/EmptyComment RuboCop offense emitted for types with no description. The AST Comment node now skips writing when docs is empty or whitespace-only, so undocumented model classes no longer produce a bare # line above their class definition.

1.12.7

(fix): Fix Layout/EmptyComment RuboCop offense emitted for types with no description. The AST Comment node now skips writing when docs is empty or whitespace-only, so undocumented model classes no longer produce a bare # line above their class definition.

1.12.6

(chore): Patch Ruby SDK generator container CVEs flagged in the AWS ECR / grype scan. Remove the unused erb-4.0.3, net-imap-0.4.21, addressable-2.8.5, rexml-3.2.5, and rexml-3.2.6 gem directories (in addition to the gemspec stubs) and install patched addressable-2.8.10 + rexml-3.4.4, so grype no longer reports the vulnerable versions vendored alongside Ruby 3.3’s default gems and the rubocop dependency graph.

1.12.5

(chore): Bump ruby-v2 model container Ruby base image to ruby:3.3-alpine3.23 (matching the ruby-v2 SDK container) and apply latest Alpine package security updates at build time.

1.12.4

(chore): Remediate container vulnerabilities flagged by the May 2026 Grype scan of the fernapi/fern-ruby-sdk image. Bumps the base image from ruby:3.3-alpine3.20 (EOL) to ruby:3.3-alpine3.23, picking up updated openssl, musl, busybox, zlib, curl, git, c-ares, ada-libs, sqlite-libs, and a Ruby 3.3.11 with newer default gems (resolv, zlib, rexml, uri). Also patches erb and net-imap over the base image (with stale gemspec cleanup so SBOM scanners see the fixed versions), upgrades npm’s bundled vulnerable packages (tar, minimatch, ip-address, picomatch, brace-expansion, @isaacs/brace-expansion, diff), and drops build-base from the runtime image (added as a virtual install-time package and removed after gem install) so binutils CVEs no longer ship in the final image. Reduces grype findings from 78 to 15 (all remaining are upstream Alpine packages with no fix available yet).

1.12.3

(fix): Apply canonical “all user-specified examples, else first autogenerated” selection in the Ruby v2 SDK snippet output path. Aligns the generator’s snippet.json / README example selection with TS-v1 / Python-v1 behavior so dynamic-IR-driven snippets are deterministic across runs.

1.12.2

(fix): Fix circular require in generated barrel file by excluding test/wire files from the main lib require list.

1.11.1

(fix): 从生成的注释行中去除尾随空格,使受规范控制的 docstring 在 #15202 中移除 rubocop -A 自动修正过程后不再触发 Layout/TrailingWhitespace。在 Square 夜间基线基准测试中发现。

1.11.0

(feat): 添加 retryStatusCodes 配置选项("legacy" | "recommended")。Legacy(默认)保留现有行为(408、429、500、502、503、504、521、522、524)。Recommended 仅重试瞬态代码(408、429、502、503、504),排除 500 Internal Server Error,以避免对非幂等失败进行重试。

1.10.0

(fix): 修复 TypeLiteral 字符串发射器中的 Ruby 字符串插值注入漏洞。包含 #{} 的不受信任的 API 规范默认值现在在生成的双引号 Ruby 字符串中得到正确转义。

(feat): 在发射器层级生成完全符合 rubocop 规范的代码,消除生成输出中所有剩余的 rubocop 违规,使生成时不再需要 rubocop -A。涵盖 Style/IfUnlessModifier(在 ruby.IfElse AST 中添加修饰符形式检测)、Style/RedundantInterpolation(用于单插值 URL 路径和标头值的裸 .to_s)、Lint/DuplicateHashKey(在 TypeLiteral 哈希发射中按键去重,并在动态代码片段关键字参数中按名称去重)以及 Layout/FirstHashElementIndentation / Layout/FirstArgumentIndentation(EnforcedStyle: consistent + 正确的线路测试分页延续缩进)。Rubocop 作为 CI 回归门禁运行(仅检查,无 -A)。