v2.1.0: Nullable, external reference improvements, x-order, and many more!

🔊 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

v2.0.0: Remove deprecated packages

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:

	Before (v1.13.0)	After (v2.0.0)
Vendored dependency size (MB)	40	6
Direct dependencies	15	6
Indirect dependencies	95	34

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.

v1.16.2: Further improve documentation notices

What's Changed

• Improve deprecation notices by @jamietanna in #1337

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

v1.16.1: Ensure deprecation comments appear correctly

What's Changed

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

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

v1.16.0: Reduce runtime dependencies

As part of the final preparation towards the v2 release, this release finalises the use of the new multi-repo packages, and deprecates all internal packages ahead of next week's release removing them.

Key callouts

• Migrate middleware to their own Go modules by @jamietanna in #1257
• Replace + deprecate testutil by @jamietanna in #1314

Full Changelog: v1.15.0...v1.16.0

v1.15.0: Remove issues with Go 1.21

Go Toolchain issues

As flagged in #1221, folks using Go 1.21 for their local builds - but maybe not targeting Go 1.21, will have been receiving diffs like:

 diff --git a/examples/go.mod b/examples/go.mod
index 4b815bd..929a5b6 100644
--- a/examples/go.mod
+++ b/examples/go.mod
@@ -1,6 +1,8 @@
 module github.com/deepmap/oapi-codegen/examples
 
-go 1.20
+go 1.21
+
+toolchain go1.21.0

This is due to changes in Go 1.21's management of toolchains, and is a side effect of Fiber and Iris targeting Go 1.21.

These dependencies have now been downgraded to requiring 1.20, and we've taken steps as maintainers to reduce the impact in the future, so we should only be targeting the lowest Go version supported by the Go team.

What's Changed

• [Gorilla] update the MiddlewareFunc type for compatibility by @namco1992 in #1134
• Re-enable moq's execution by @jamietanna in #1229
• Bump fiber to v2.49.1 by @jamietanna in #1232
• Build project with Go 1.20 and Go 1.21 by @jamietanna in #1251
• Bump Iris to remove Go 1.21 dependency by @jamietanna in #1249

New Contributors

• @namco1992 made their first contribution in #1134

Full Changelog: v1.14.0...v1.15.0

v1.14.0: Iris Support, Go 1.20 requirement, reduction of runtime dependencies, and various other features and fixes

Key callouts

• Update to minimum of Go 1.20 by @jamietanna in #1184
• Work to reduce transitive dependencies by @jamietanna in #1206
  • This introduces the first package in github.com/oapi-codegen

What's Changed

• Bump golang.org/x/text from 0.11.0 to 0.12.0 by @dependabot in #1183
• Update to minimum of Go 1.20 by @jamietanna in #1184
• [Codegen] Update lint module for tests by @eugenio-bolt in #1191
• Bump golang.org/x/tools from 0.11.1 to 0.12.0 by @dependabot in #1193
• Use Makefile for linting + increase golangci-lint timeout by @jamietanna in #1198
• Fix: Allow consumers to specify how many circular references are allowed by @jamietanna in #1204
• Allow setting globalState.spec without Generate by @derbylock in #1174
• support staticcheck st1005 by @Hyuga-Tsukui in #1124
• Add Gorilla test case for strict-server by @jamietanna in #1218
• Feat: Add Iris Server Support by @Ns2Kracy in #1088
• Bump github.com/google/uuid from 1.3.0 to 1.3.1 by @dependabot in #1215
• Bump github.com/gofiber/fiber/v2 from 2.48.0 to 2.49.0 by @dependabot in #1216
• Work to reduce transitive dependencies by @jamietanna in #1206
• Override local parameters to global parameters by @ShouheiNishi in #1181
• Fix 'cannot define new methods on non-local type' error by @ShouheiNishi in #1185
• Fix enum in anyOf by @ShouheiNishi in #1207
• Fix reference of multipart response by @ShouheiNishi in #1213
• Fix for multiple JSON media type by @ShouheiNishi in #1210
• Allow merging of schemas with additionalProperties by @ShouheiNishi in #1220
• feat: set retrieve timeout for getting the template text from remote by @alexandear in #1170

New Contributors

• @eugenio-bolt made their first contribution in #1191
• @derbylock made their first contribution in #1174
• @Hyuga-Tsukui made their first contribution in #1124
• @Ns2Kracy made their first contribution in #1088

Full Changelog: v1.13.4...v1.14.0

v1.13.4

What's Changed

• Fix: Generate models for all JSON media types by @jamietanna in #1177

Full Changelog: v1.13.3...v1.13.4

v1.13.3

What's Changed

• fix: correct marshalling for +json types for strict servers by @reinkrul in #1171

Full Changelog: v1.13.2...v1.13.3

Fix: Allow multiple JSON types to be generated

What's Changed

• Fix: Allow multiple JSON types to be generated by @jamietanna in #1159
• Bump github.com/matryer/moq from 0.3.1 to 0.3.2 by @dependabot in #1160
• Bump github.com/labstack/echo/v4 from 4.10.2 to 4.11.1 by @dependabot in #1161
• Bump github.com/go-chi/chi/v5 from 5.0.8 to 5.0.10 by @dependabot in #1162

Full Changelog: v1.13.1...v1.13.2