Skip to content

Commit 5559558

Browse files
Jamie Tannajamietanna
authored andcommitted
docs: update package documentation
As it could do with more information.
1 parent 9158b3c commit 5559558

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

oapi_validate.go

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
// Package middleware implements middleware function for net/http compatible router
2-
// which validates incoming HTTP requests to make sure that they conform to the given OAPI 3.0 specification.
3-
// When OAPI validation fails on the request, we return an HTTP/400.
1+
// Provide HTTP middleware functionality to validate that incoming requests conform to a given OpenAPI 3.x specification.
2+
//
3+
// This provides middleware for any `net/http` conforming HTTP Server.
4+
//
5+
// This package is a lightweight wrapper over https://pkg.go.dev/github.com/getkin/kin-openapi/openapi3filter from https://pkg.go.dev/github.com/getkin/kin-openapi.
6+
//
7+
// This is _intended_ to be used with code that's generated through https://pkg.go.dev/github.com/oapi-codegen/oapi-codegen, but should work otherwise.
48
package nethttpmiddleware
59

610
import (

0 commit comments

Comments
 (0)