Skip to content

OpenAPI validation extension for libopenapi, validate http requests and responses as well as schemas

License

Notifications You must be signed in to change notification settings

pb33f/libopenapi-validator

Repository files navigation

libopenapi

Enterprise grade OpenAPI validation tools for golang.

Pipeline codecov discord Docs

A validation module for libopenapi.

libopenapi-validator will validate the following elements against an OpenAPI 3+ specification

  • http.Request - Validates the request against the OpenAPI specification
  • http.Response - Validates the response against the OpenAPI specification
  • libopenapi.Document - Validates the OpenAPI document against the OpenAPI specification
  • base.Schema - Validates a schema against a JSON or YAML blob / unmarshalled object

👉👉 Check out the full documentation 👈👈


Installation

go get github.com/pb33f/libopenapi-validator

Validate OpenAPI Document

go run github.com/pb33f/libopenapi-validator/cmd/validate@latest [--regexengine] <file>

🔍 Example: Use a custom regex engine/flag (e.g., ecmascript)

go run github.com/pb33f/libopenapi-validator/cmd/validate@latest --regexengine=ecmascript <file>

🔧 Supported --regexengine flags/values (ℹ️ Default: re2)

  • none
  • ignorecase
  • multiline
  • explicitcapture
  • compiled
  • singleline
  • ignorepatternwhitespace
  • righttoleft
  • debug
  • ecmascript
  • re2
  • unicode

Documentation

libopenapi and libopenapi-validator are products of Princess Beef Heavy Industries, LLC