lua-resty-openapi-validator - Pure Lua OpenAPI request validator for OpenResty / LuaJIT.

• Description
• Install
• Quick Start
• API
• Validation Scope
• OpenAPI 3.1 Support
• Testing

Validates HTTP requests against OpenAPI 3.0 and 3.1 specifications using lua-resty-radixtree for path matching and api7/jsonschema for schema validation. Pure Lua, no external processes required.

Dependencies

• api7/jsonschema — JSON Schema Draft 4/6/7 validation
• lua-resty-radixtree — radix tree path routing
• lua-cjson — JSON encoding/decoding

install by luarocks

luarocks install lua-resty-openapi-validator

install by source

git clone https://github.com/api7/lua-resty-openapi-validator.git
cd lua-resty-openapi-validator
make dev
sudo make install

Back to TOC

local ov = require("resty.openapi_validator")

-- compile once (cache the result)
local validator, err = ov.compile(spec_json_string, {
    strict = true,  -- error on unsupported 3.1 keywords (default: true)
})
if not validator then
    ngx.log(ngx.ERR, "spec compile error: ", err)
    return
end

-- validate per-request
local ok, err = validator:validate_request({
    method       = ngx.req.get_method(),
    path         = ngx.var.uri,
    query        = ngx.req.get_uri_args(),
    headers      = ngx.req.get_headers(0, true),
    body         = ngx.req.get_body_data(),
    content_type = ngx.var.content_type,
})

if not ok then
    ngx.status = 400
    ngx.say(err)
    return
end

See API documentation for details on all methods and options.

Back to TOC

Back to TOC

OpenAPI 3.1 uses JSON Schema Draft 2020-12. Since the underlying jsonschema library supports up to Draft 7, schemas are normalized at compile time:

Back to TOC

make test

Runs unit tests and conformance tests covering OpenAPI 3.0 / 3.1 features (parameter serialization, request body validation, discriminator, $ref, readOnly/writeOnly, deepObject/form/multipart, etc.).

Back to TOC

Apache 2.0