🐛 Bug fixes

• fix(templates): correctly nil check arrays (#2118) @jamietanna
• fix: report formatting errors with line numbers (#2117) @jamietanna
• fix(output-options): correctly reference x-go-type-skip-optional-pointer in allOf (#2042) @magnetikonline

📝 Documentation updates

• docs: clarify support + go directives (#2099) @jamietanna
• docs: correct level of headers (#2095) @jamietanna
• docs(sponsors): update Speakeasy logo (#2049) @chailandau
• Fix bullet point line prefer-skip-optional-pointer-with-omitzero typo in README.md (#2028) @magnetikonline

👻 Maintenance

• build: handle additional values in GOVERSION (#2119) @jamietanna
• build: add explicit permissions blocks for tidy.yml (#2101) @jamietanna
• build: add explicit permissions blocks for Actions (#2100) @jamietanna
• build: add Scorecards workflow (#2098) @jamietanna
• build: capture govulncheck results as Code Scanning alerts (#2084) @jamietanna
• build: test against Go 1.25 (#2056) @jamietanna

📦 Dependency updates

Sponsors

We would like to thank our sponsors for their support during this release.

v2.5.0: No more optional pointers (optionally)!

🎉 Notable changes

Begone optional pointers! (optionally)

One of the key things oapi-codegen does is to use an "optional pointer", following idiomatic Go practices, to indicate that a field/type is optional.

This can be tuned on a per-field basis, using the x-go-type-skip-optional-pointer extension, but it can be a bit repetitive, or can be more complex when using an OpenAPI Overlay.

As of oapi-codegen v2.5.0, this can be tuned in two specific ways, via the following Output Options:

• prefer-skip-optional-pointer: a global default that you do not want the "optional pointer" generated. Optional fields will not have an "optional pointer", and will have an omitempty JSON tag
• prefer-skip-optional-pointer-with-omitzero: when used in conjunction with prefer-skip-optional-pointer, any optional fields are generated with an omitzero JSON tag. Requires Go 1.24+

In both cases, there is control on a per-field level to set x-go-type-skip-optional-pointer: false or x-omitzero: false to undo these to field(s).

See Globally skipping the "optional pointer" for more details.

Generating omitzero JSON tags, with x-omitzero

Related to the above functionality, it is possible to define the OpenAPI extension x-omitzero on fields to generate the omitzero JSON tag, based on the (now not-so-new) Go 1.24 release.

Thanks to @lzap for the contribution 🚀

Using OpenAPI 3.1 with oapi-codegen

There's some promising behind-the-scenes discussions with may lead to OpenAPI 3.1 support (#373) coming in the not-too-distant future 👀

In the meantime, Jamie (one of the Core Maintainers) has written a blog post about how to use oapi-codegen with OpenAPI 3.1 specs (by downgrading them to OpenAPI 3.0).

Defining your own initialisms

As a means to define your own custom initialisms, it's possible to use the additional-initialisms Output Option.

Thanks @micaelmalta for the contribution 🚀

If your organisation uses a lot of TLAs (Two Letter Acronyms or Three Letter Acronyms) or any other sorts of initialisms, it's handy to be able to configure these yourself.

For instance, if you regularly use the term CSP to refer to Cloud Service Provider, you may want CSP to be used in variable names.

This makes it possible to define i.e.

# ...
output-options:
  name-normalizer: ToCamelCaseWithInitialisms
  additional-initialisms:
    - CSP

Minimum version of Go needed for oapi-codegen is now 1.22.5

As part of a couple of updates in #1888 and #1986, we're now requiring Go >= 1.22.5.

Similar to the bump to Go 1.21 in v2.4.0

Notable background work

Since the last oapi-codegen release (all the way in September 2024 🥲) the following big changes towards the project and its ecosystem have been:

• net/http middleware v1.1.0: Better error handling, allow not validating Servers (by configuration) and return an HTTP 405 Method Not Allowed where appropriate
• Jamie posted a look back at the last year
  • Notably also writing up explicitly how the project is currently governed
• runtime: fixes for maps and x-go-type-skip-optional-pointer

🚀 New features and improvements

• feat(client): Add Bytes() to ClientWithResponses responses (#1780) @grongor
• feat(generate): allow generating Server URL boilerplate (#2002) @jamietanna
• feat(output-options): add prefer-skip-optional-pointer-on-container-types (#1979) @jamietanna
• feat(output-options): add prefer-skip-optional-pointer to default to skipping optional pointers (#1694) @aksdb
• feat(output-options): add yaml-tags option (#1798) @deitch
• feat(templates): consolidate logic for whether to use an optional pointer (#1981) @jamietanna
• feat(x-deprecated-reason): add default deprecation message (#2022) @jamietanna
• feat: allow specifying additional-initialisms (#1733) @micaelmalta

🐛 Bug fixes

• Handle leading underscores in property names (#1822) @tobio
• fix(codegen): allow exposing the input spec's operationId (#1945) @jamietanna
• fix(codegen): allow using x-go-type and x-go-type-skip-optional-pointer together (#1957) @Nivl
• fix(output-options): obey prefer-skip-optional-pointer in reference types + add tests for preferskipoptionalpointer (#2021) @jamietanna
• fix(overlay): correctly resolve references after Overlay application (#1825) @jgraeger
• fix(stdhttp): correctly generate root paths (#1953) @jamietanna
• fix: Print the warning message to stderr instead of stdout (#1895) @ignassew
• fix: create directories if they do not exist before writing output file (#1994) @kf-pineapple
• fix: don't generate an "optional pointer" for unknown types (#610) @jens1205

📝 Documentation updates

• docs: add example for how to downgrade OpenAPI 3.1 to 3.0 (#1966) @jamietanna
• Add blog post about using oapi-codegen in a Chi project (#1791) @0xi4o
• Fix broken anchor link for validation middleware section (#2013) @Park-Jongseok
• chore(tests): add additional test case for underscore naming (#1980) @jamietanna
• docs(client): document known issue with duplicated Response models (#2025) @jamietanna
• docs(extensions): correct typo to example (#1999) @i-sevostyanov
• docs(extensions): don't use <details> blocks in <table> (#2019) @jamietanna
• docs(extensions): update example code for x-enumNames (#2000) @jamietanna
• docs(middleware): clarify use of nethttp-middleware for other purposes (#1951) @jamietanna
• docs(sponsors): add Livepeer (#1849) @jamietanna
• docs(sponsors): update Speakeasy URL (#1970) @ndimares
• docs(std-http-server): warn when not using Go 1.22 (#1967) @jamietanna
• docs: add contributors image (#1795) @jamietanna
• docs: add example of using go tool for Go 1.24+ (#1908) @jamietanna
• docs: fix GitHub flavoured markdown (#1934) @MarvinJWendt
• docs: fix typo in flags usage (#1796) @AlekSi
• docs: note the use of a multi-module tools.go (#1788) @jamietanna
• docs: simplify go tool example (#1910) @gaiaz-iusipov

• docs(additional-initialisms): add a usage example (#2026) @jamietanna

👻 Maintenance

• build(labels): add additional labelling (#1848) @jamietanna
• build(labels): add autolabeller for "no main branch please" (#1847) @jamietanna
• build: build against Go 1.24 (#1901) @jamietanna
• build: ensure separately named "Check results" steps (#1850) @jamietanna
• chore(examples): use Go 1.24 with Go 1.24 example (#1925) @jamietanna
• chore(tests): add additional test case for underscore naming (#1980) @jamietanna
• chore: don't use non-GitHub URL for tests (#1926) @jamietanna
• fix(output-options): obey prefer-skip-optional-pointer in reference types + add tests for preferskipoptionalpointer (#2021) @jamietanna

📦 Dependency updates

Sponsors

We would like to thank our sponsors for their support during this release.

🐛 Bug fixes

• fix(import-mapping): don't produce unused variable when one mapping (#1781) @ottaviohartman

📝 Documentation updates

• docs(sponsors): clarify Elastic's 4h/mo (#1783) @jamietanna

👻 Maintenance

• build: remove patch version pinning on go directive (#1784) @jamietanna

Sponsors

We would like to thank our sponsors for their support during this release.

🎉 Notable changes

Modifying the input OpenAPI Specification, without needing to modify it directly

Prior to oapi-codegen v2.4.0, users wishing to override specific configuration, for instance taking advantage of extensions such as x-go-type would need to modify the OpenAPI specification they are using.

In a lot of cases, this OpenAPI specification would be produced by a different team to the consumers (or even a different company) and so asking them to make changes like this were unreasonable.

This would lead to the API consumers needing to vendor the specification from the producer (which is our recommendation anyway) and then make any number of local changes to the specification to make it generate code that looks reasonable.

However, in the case that a consumer would update their specification, they would likely end up with a number of merge conflicts.

Now, as of oapi-codegen v2.4.0, it is now possible to make changes to the input OpenAPI specification without needing to modify it directly.

This takes advantage of the OpenAPI Overlay specification, which is a stable specification.

We're very excited for y'all to be able to take advantage of this, and to be able to manipulate complex specifications you don't have control over.

Using a single package, with multiple OpenAPI spec for a given package

Since oapi-codegen v2.4.0, it is now possible to split large OpenAPI specifications into the same Go package, using the "self" mapping (denoted by a -) when using Import Mapping.

This is an improvement on the previous model, which would require splitting files across multiple packages.

This should improve the ability to use a multi-file OpenAPI specification.

Reverting a breaking change to Strict servers using text/plain

Changes in #1132 had unintended side effects, and so we have reverted this.

This will be a breaking change to anyone who had pulled in this change, since it landed in v1.13.1.

Minimum version of Go needed for oapi-codegen is now 1.21

Does what it says on the tin.

This was required for a new dependency, and given Go 1.21 is now End-of-Life, this isn't too bad a requirement, without requiring folks unnecessarily bump their minimum supported version higher.

Starting work towards the OpenSSF Best Practices badge

As a means to better understand the compliance of oapi-codegen with OpenSSF's Best Practices guide, we've started work towards the "passing" badge.

This gives us some insight into where we have gaps, and makes it known for our users, too.

PR Builds now have required status checks

Previously, PR builds did not have a required status check.

Although as maintainers we would only merge changes after the CI checks had passed, this now gives us - and you as our users - greater confidence in the stability of the project.

Previously raised PRs - before 2024-09-20 - will need to merge in the latest changes in main before these status checks will pass.

🚀 New features and improvements

• feat: allow import-mapping to the current package (#1774) @jamietanna @djgilcrease
• feat(std-http): accept Mux interface instead of *http.ServeMux (#1720) @sonalys
• feat: handle < and > in property or type names (#1740) @ansoni
• feat: add support for OpenAPI Overlay (#1727) @jamietanna
• feat(extension): add x-oapi-codegen-only-honour-go-name (#1697) @jamietanna

🐛 Bug fixes

• Revert "fix(template): fix strict-interface template to make sure text response content type uses string type (#1132)" (#1773) @jamietanna
• fix: correctly generate structs and properties for anyOfs (#1178) @daleef-rahman
• fix(cookies): wrap cookie variables in block scope (#1687) @andremarianiello
• fix(extensions): use the x-order from next to $ref, if present (#1700) @paulmach
• fix(oapi-codegen): add missing newline to error when swagger spec load fails (#1688) (#1690) @willbuckner

📝 Documentation updates

• docs: correct wording of heading (#1776) @jamietanna
• docs: remove deepmap/oapi-codegen references (#1771) @jamietanna
• docs(tests): add an example of using in: cookie (#1770) @jamietanna
• docs(sponsors): add Cybozu (#1768) @jamietanna
• docs: add link to OpenSSF Best Practices badge (#1761) @jamietanna
• Update CONTRIBUTING.md (#1750) @joeriddles
• docs(overlay): improve Overlay docs (#1749) @jamietanna
• Fix usage YAML example schema path in README.md (#1748) @gren236
• Update link for DevZero (#1716) @dray92
• Update speakeasy URL on oapi-codegen (#1707) @ndimares
• docs(sponsors): add Elastic (#1667) @jamietanna
• docs(sponsors): add FUNDING.yml (#1661) @jamietanna
• docs(sponsors): add Speakeasy (#1649) @jamietanna
• docs: correct module path replacements (#1657) @jamietanna
• docs: clarify module version installations (#1653) @jamietanna

👻 Maintenance

• build: check results of matrix jobs (#1769) @jamietanna
• build: require Go 1.21 to build (#1728) @jamietanna
• build: validate against Go 1.23 (#1724) @jamietanna
• chore: make it possible to provide detailed config validation errors (#1699) @jamietanna
• chore: remove accidental compiled binary (#1698) @jamietanna
• Avoid extra http.Request allocation (stdhttp, chi, gorilla) (#1673) @gaiaz-iusipov
• chore: correct Release Drafter branch (#1654) @jamietanna

📦 Dependency updates

Sponsors

We would like to thank our sponsors for their support during this release.

With this version, oapi-codegen consolidates all code under github.com/oapi-codegen. When you install the core tool, please use this new location, github.com/oapi-codegen/oapi-codegen/v2 starting with version v2.3.0, but continue to use github.com/deepmap/oapi-codegen/v2 with any earlier release.

This release contains changes to import paths, go.mod and the README.

What's Changed

• chore(deps): update middleware dependencies by @jamietanna in #1636
• Rename module post-move by @mromaszewicz in #1643
• Update README by @mromaszewicz in #1646
• Update readme with install instrctions by @mromaszewicz in #1652

Full Changelog: v2.2.0...v2.3.0

Big announcements

In case you've missed it, we've got a few big announcements as maintainers of oapi-codegen which we'd recommend you read in more depth.

• oapi-codegen is moving to its own org
  • This is from release v2.3.0, but will be enacted likely before you get a chance to read these release notes, as we want to migrate everything to the same org ASAP
• Creating a more sustainable model for oapi-codegen in the future
  • Please consider looking at sponsoring the maintenance that we do on the project.

We'd also like to thank our sponsors for this release:

🔊 Notable features

The v2.2.0 release was largely focussed on the following big changes, alongside a number of other bug fixes.

Generate a pure Go 1.22+ net/http server

With Go 1.22+'s enhanced routing, it's now easier than ever to be able to write a pure-Go HTTP service, and thanks to a contribution from @thedadams we now have a std-http-server, further documented in the Supported Servers section in the README.

Documentation overhaul

A significant undertaking in this release was to rewrite pretty much every line of documentation we had, as well as introducing a number of additional examples and test cases.

We're excited to hear your feedback on the new structure of the README, the additional docs added, and whether there are any additional examples that may be of use.

JSON Schema configuration

In the spirit of documentation, we now also have a JSON schema which can be found further documented in the Usage section in the README.

This not only gives a separate definition of fields and their meaning, but it can be used with IDEs for autocompletion and validation, allowing for a much better Developer Experience.

kin-openapi upgrade

A few big upgrades have come in kin-openapi, which we use for the underlying OpenAPI parsing and validation, which included a significant breaking change that meant that consumers of oapi-codegen couldn't upgrade the kin-openapi version until we had made changes in oapi-codegen.

This has additionally been set up as an FAQ as it's one we commonly get.

🚀 New features and improvements

• feat: add ability to tweak generated names (including use of initialisms) (#1041) @wtertius
• docs: revamp README, add a CONTRIBUTING.md and add a JSON Schema for configuration files (#1485) @jamietanna
• feat: add support for Go 1.22+ net/http routing (#1475) @thedadams

🐛 Bug fixes

• Bug: using x-go-type-name results in missing types (#1397) @jamesphillpotts-fr
• fix: correctly register Fiber middleware (#1615) @jamietanna
• fix: ensure we pre-import nullable (#1585) @jamietanna
• Prefactor: Changes from #1475 (#1480) @jamietanna
• Ensure docstring comment names are set correctly (#1457) @ConorPKeegan

📝 Documentation updates

• docs(sponsors): add a Sponsors section in README (#1635) @jamietanna
• docs(examples): document how to set up authenticated middleware with a non-echo server (#1627) @jamietanna
• docs(extensions): add missing x-go-type-name docs (#1616) @jamietanna
• chore: log warning when using 3.1.x (#1592) @jamietanna
• docs: link to blog post for syncing vendored specs (#1580) @jamietanna
• docs: correct std-http-server example (#1576) @sajjanjyothi
• docs: revamp README, add a CONTRIBUTING.md and add a JSON Schema for configuration files (#1485) @jamietanna
• docs: update OpenAPI spec links to main branch (#1493) @dharsanb
• Add Fiber example in README (#1495) @alexandregv
• Prefactor: Changes from #1475 (#1480) @jamietanna
• docs: use relative links to files (#1471) @alexandear

👻 Maintenance

• chore: add missing test case for replaceInitialism (#1624) @alexandear
• Simplify extensions merge in mergeOpenapiSchemas (#1424) @Juneezee
• chore: log warning when using 3.1.x (#1592) @jamietanna
• refactor: extension variable instead of accessing extensions directly (#1448) @alexandear
• chore(deps): remove dependency on golang.org/x/lint (#1588) @jamietanna
• docs: revamp README, add a CONTRIBUTING.md and add a JSON Schema for configuration files (#1485) @jamietanna
• chore: add test case for additionalProperties bug (#1528) @jamietanna
• Prefactor: Build changes for #1475 (#1482) @jamietanna
• Prefactor: Changes from #1475 (#1480) @jamietanna
• Simplify CI build matrix + build against Go 1.22 (#1459) @jamietanna

📦 Dependency updates

🔊 Notable features

Nullable types

It's possible that you want to be able to determine whether a field isn't sent, is sent as null or has a value.

For instance, if you had the following OpenAPI property:

S:
  type: object
  properties:
    Field:
      type: string
      nullable: true
    required: []

The current behaviour in oapi-codegen is to generate:

type S struct {
	Field *string `json:"field,omitempty"`
}

However, you lose the ability to understand the three cases, as there's no way to distinguish two of the types from each other:

• is this field not sent? (Can be checked with S.Field == nil)
• is this field null? (Can be checked with S.Field == nil)
• does this field have a value? (S.Field != nil && *S.Field == "123")

Therefore, as requested in #1039, this is now possible to represent with the nullable.Nullable type from our new library, oapi-codegen/nullable.

If you configure your generator's Output Options as so:

output-options:
  nullable-type: true

You will now receive the following output:

type S struct {
    Field nullable.Nullable[string] `json:"field,omitempty"`
}

Note that this is opt-in only, due to it being a break in existing signatures and behaviour.

You can find out more about how this works in a blog post with further details.

External references are now handled better

A big change has come in which handling of external references (also called import mappings) is much more resilient and predictable for generated code.

This allows cases where multiple files referencing each other (for instance if you've split your API across multiple files, and join them using $refs) now correctly generate code.

There are a few cases that won't be covered, that we'll complete in #1440 but until then, it hopefully should work better.

Thank you to Ejendomstorvet for sponsoring this work.

🚀 New features and improvements

• Add support for x-order extension (#1190) @filintod
• Make arrays use concrete types, not aliases. (#1246) @jkj
• feat: filter by operation ids (#929) @johanneswuerbach
• Allow generating nullable.Nullable for nullable properties (#1404) @sonasingh46
• Support media type parameters for IsMediaTypeJson (#1386) @jamietanna
• Pass .Required to BindStyledParameterWithLocation and BindStyledParameter (#1315) @renom

🐛 Bug fixes

• Fix: Ensure external refs are propagated to generated code (#1389) @jamietanna
• Fix: Refer to external refs correctly in strict interfaces (#1387) @jamietanna
• refactor(cmd): Use os.Exit(1) only from main() (#1398) @alexandear
• Fix binding for JSON body (#1299) @ShouheiNishi
• Fix: Handle code generation for all multipart content-types (#1385) @ShouheiNishi
• Pass .Required to BindStyledParameterWithLocation and BindStyledParameter (#1315) @renom

📝 Documentation updates

• Fixes confusing indentation for example code in README.md (#1414) @mtskg
• Document how to use import-mapping with URLs (#1428) @jamietanna
• Fix typo in README.md (#1351) @eltociear

👻 Maintenance

• Fix typos in flag, tests, doc, and comments (#1287) @alexandear
• add unit tests for go type gen function (#1423) @sonasingh46
• Use non-deprecated function names for oapi-codegen/runtime (#1359) @cimitan
• Onboard to Release Drafter (#1350) @jamietanna

📦 Dependency updates

• Update module github.com/golangci/golangci-lint to v1.55.2 (#1285) @renovate
• feat: bump github.com/getkin/kin-openapi to v0.122.0 (#1364) @chrisgacsal
• Update module golang.org/x/text to v0.14.0 (#1349) @renovate

New Contributors

• @renom made their first contribution in #1315
• @eltociear made their first contribution in #1351
• @chrisgacsal made their first contribution in #1364
• @cimitan made their first contribution in #1359
• @sonasingh46 made their first contribution in #1423
• @mtskg made their first contribution in #1414
• @jkj made their first contribution in #1246
• @filintod made their first contribution in #1190

As announced in oapi-codegen v2 is coming, this is a release to perform some cleanup, drastically reducing the dependency graph for users of the library, and migrating to multi-repo middleware and utility packages that can evolve separately to the code generator itself.

There's more details in https://www.jvt.me/posts/2023/10/23/oapi-codegen-v2-decrease/ in the exact benefits ??, but the key metrics you will be interested in seeing are:

Key changes

Full Changelog: v1.16.2...v2.0.0

As a consumer, for the most part you shouldn't have much to do, as if you've been using oapi-codegen v1.15.0 or later, you should be using the new packages.

If you use this as a library or execute it as part of go run you will need to update module import paths:

-//go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen --config=config.yaml spec.yaml
+//go:generate go run github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml spec.yaml

If you're installing the package via go install, you'll need to run the following instead:

-go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@latest
+go install github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen@latest

Move pkg/testutil to its own package + remove it

Similar to the below changes, we've moved pkg/testutil to its own package, and removed it from the codebase.

The changes for you as a consumer can be seen here.

This is almost a drop in replacement, the key difference is that there is no longer a RequestBuilder.Go method, as it is replaced by the RequestBuilder.GoWithHTTPHandler.

Remove deprecated packages:

For the packages:

• pkg/chi-middleware
• pkg/fiber-middleware
• pkg/gin-middleware
• pkg/middleware
• pkg/runtime
• pkg/types

These have been deprecated because they are now hosted as individual modules at https://github.com/oapi-codegen/. Doing so allows for their dependencies to be separated from each other, so your transitive module dependencies decrease. Any code which you generate using v1.15.0 will already refer to these modules in their new location.

What's Changed

• Improve deprecation notices by @jamietanna in #1337

Full Changelog: v1.16.1...v1.16.2

What's Changed

• Fix: Ensure deprecations are parsed correctly by @jamietanna in #1335

Full Changelog: v1.16.0...v1.16.1