1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
|
package openapi3filter_test
import (
"context"
"fmt"
"net/http"
"strings"
"github.com/getkin/kin-openapi/openapi3"
"github.com/getkin/kin-openapi/openapi3filter"
"github.com/getkin/kin-openapi/routers/gorillamux"
)
func ExampleOptions_WithCustomSchemaErrorFunc() {
const spec = `
openapi: 3.0.0
info:
title: 'Validator'
version: 0.0.1
paths:
/some:
post:
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
field:
title: Some field
type: integer
responses:
'200':
description: Created
`
loader := openapi3.NewLoader()
doc, err := loader.LoadFromData([]byte(spec))
if err != nil {
panic(err)
}
if err = doc.Validate(loader.Context); err != nil {
panic(err)
}
router, err := gorillamux.NewRouter(doc)
if err != nil {
panic(err)
}
opts := &openapi3filter.Options{}
opts.WithCustomSchemaErrorFunc(func(err *openapi3.SchemaError) string {
return fmt.Sprintf(`field "%s" must be an integer`, err.Schema.Title)
})
req, err := http.NewRequest(http.MethodPost, "/some", strings.NewReader(`{"field":"not integer"}`))
if err != nil {
panic(err)
}
req.Header.Add("Content-Type", "application/json")
route, pathParams, err := router.FindRoute(req)
if err != nil {
panic(err)
}
validationInput := &openapi3filter.RequestValidationInput{
Request: req,
PathParams: pathParams,
Route: route,
Options: opts,
}
err = openapi3filter.ValidateRequest(context.Background(), validationInput)
fmt.Println(err.Error())
// Output: request body has an error: doesn't match schema: field "Some field" must be an integer
}
|