Direct link to release

🔊 Notable features

Error handling is now significantly better

As part of #35, we have introduced a much more powerful means to handle the errors returned by the OpenAPI Validation middleware.

This has been a long-standing issue, and we appreciate the community's patience as well as different proposals over time.

Previously, when creating an error handler, the method signature was fairly lacking:

// create middleware
mw := middleware.OapiRequestValidatorWithOptions(spec, &middleware.Options{
    Options: openapi3filter.Options{
        AuthenticationFunc: authenticationFunc,
    },
    ErrorHandler: func(w http.ResponseWriter, message string, statusCode int) {
        http.Error(w, "This text/plain response will be returned to the caller: " + message, statusCode)
    },
})

This didn't give much information around what had happened - or in which route/endpoint - and not having the raw error made observability and additional steps to respond appropriately more difficult.

With this release, it's now possible to have the raw error, information about the current request + its context.Context, as well as some additional pieces of metadata inside the ErrorHandlerWithOpts:

// create middleware
mw := middleware.OapiRequestValidatorWithOptions(spec, &middleware.Options{
    // other options
    // ...
    ErrorHandlerWithOpts: func(ctx context.Context, err error, w http.ResponseWriter, r *http.Request, opts middleware.ErrorHandlerOpts) {
        // NOTE that ErrorHandlerOpts contains further information, and allows us to add additional information in the future, in an extensible and non-breaking way
    }
})

There is a full example of usage in the Go doc for this project.

Note that the old method, ErrorHandler has been marked as deprecated - there is no planned removal date, and this is largely as a way to "nudge" folks to using the new, more powerful, method.

🚀 New features and improvements

• feat: add error handler with more configuration (client with responses doesn't conform to basic client for some responses #35) @jamietanna @pebo @mikeschinkel @MattiasMartens
  • refactor: migrate error to a method parameter, not part of ErrorHandlerOpts (Issue with RequestBody types in generated code #43) @jamietanna
• feat: allow not validating Servers at all (Client implantation example #37) @jamietanna

🐛 Bug fixes

• fix: return HTTP 405 when request method mismatch (Type name hints via extensions #25) @nek023

📝 Documentation updates

• docs: correct accidentally hardcoded error message (Use existing struct for additionalProperties that ref a schema #36) @jamietanna
• docs: rewrite README, add example test + improve comments (Reserved golang keywords in spec cause errors #30) @jamietanna
• docs(sponsors): add FUNDING.yml (Embed runtime code into generated boilerplate #20) @jamietanna

👻 Maintenance

• chore(deps): remove testutil (typo #33) @jamietanna
• chore: remove references to Swagger (sort output for response handler case statement #32) @jamietanna

📦 Dependency updates

• chore(deps): update module github.com/golangci/golangci-lint to v2.1.4 (Added a NewClientWithResponsesAndRequestEditorFunc function and updated the RequestEditor to use a type #38) @renovate[bot]
• chore(deps): update module github.com/golangci/golangci-lint to v2 (Response payload names and comments #28) @renovate[bot]
• chore(deps): pin dependencies (Meaningful validation error responses #31) @renovate[bot]

Sponsors

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