Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ahx committed Jan 6, 2024
1 parent 8cc40e6 commit b5bfaef
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,16 @@ request.headers
request.cookies

# Validate the request
request.validate # Returns OpenapiFirst::RequestValidation::Failure if validation fails
request.validate # Returns OpenapiFirst:::Failure if validation fails
request.validate! # Raises OpenapiFirst::RequestInvalidError or OpenapiFirst::NotFoundError if validation fails

# Find the response
rack_response = Rack::Response[*app.call(env)]
response = request.response(rack_response) # or definition.response(rack_request, rack_response)

# Validate response
response.validate! # Raises OpenapiFirst::ResponseInvalidError if validation fails
response.validate # Returns OpenapiFirst::Failure
response.validate! # Raises OpenapiFirst::ResponseInvalidError or OpenapiFirst::ResponseNotFoundError if validation fails
```

OpenapiFirst uses [`multi_json`](https://rubygems.org/gems/multi_json).
Expand Down

0 comments on commit b5bfaef

Please sign in to comment.