Liking cljdoc? Tell your friends :D

nl.zeekat.ring-openapi-validator


openapi-validatorclj

(openapi-validator spec)
(openapi-validator spec {:keys [base-path inline?] :as opts})

Build an OpenApiInteractionValidator from a spec

spec is a url or path to resource describing a Swagger or OpenApi specification.

opts is an optional map of options:

  • :base-path overrides the base path in the spec.
  • :inline? true indicate that spec is the specification body as a string, instead of a url or path

If you need to customize the validator you can create a builder using com.atlassian.oai.validator.OpenApiInteractionValidator/createFor

Build an OpenApiInteractionValidator from a spec

`spec` is a url or path to resource describing a Swagger or OpenApi
specification.

`opts` is an optional map of options:
 - `:base-path` overrides the base path in the spec.
 - `:inline? true` indicate that `spec` is the specification body
    as a string, instead of a url or path

If you need to customize the validator you can create a builder using
`com.atlassian.oai.validator.OpenApiInteractionValidator/createFor`
sourceraw docstring

validate-interactionclj

(validate-interaction validator request response)

Validate a request/response pair using the given validator.

If any issues are found, returns a report collection

Validate a `request`/`response` pair using the given `validator`.

If any issues are found, returns a report collection
sourceraw docstring

validate-requestclj

(validate-request validator request)

Validate a request using the given validator.

If any issues are found, returns a report collection

Validate a `request` using the given `validator`.

If any issues are found, returns a report collection
sourceraw docstring

validate-responseclj

(validate-response validator method path response)

Validate a response using the given validator.

  • method is a ring-spec method: :get :head :post etc...
  • path is the request path excluding parameters

If any issues are found, returns a report collection

Validate a `response` using the given `validator`.

- `method` is a ring-spec method: `:get` `:head` `:post` etc...
- `path` is the request path excluding parameters

If any issues are found, returns a report collection
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close