-
Notifications
You must be signed in to change notification settings - Fork 0
/
example_test.go
188 lines (174 loc) · 4.38 KB
/
example_test.go
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
package nvalid_test
import (
"context"
"encoding/json"
"fmt"
"io/ioutil"
"net/http/httptest"
"strings"
"github.com/getkin/kin-openapi/openapi2"
"github.com/getkin/kin-openapi/openapi2conv"
"github.com/ghodss/yaml"
"github.com/gorilla/mux"
"github.com/muir/nape"
"github.com/muir/nvalid"
"github.com/muir/nvelope"
)
const swagger = `
swagger: "2.0"
info:
version: 1.0.0
title: testing
schemes:
- "http"
paths:
/foo/{bar}:
post:
summary: Example
produces:
- application/json
parameters:
- name: bar
in: path
type: number
required: true
description: example path parameter
- name: baz
in: query
type: string
format: email
required: true
description: example query parameter
- name: body
in: body
schema:
type: object
required:
- john
properties:
john:
type: boolean
betty:
type: string
required: true
description: example body parameter
responses:
200:
description: response
schema:
type: object
required:
- status
additionalProperties: false
properties:
status:
type: integer
weight:
type: number
400:
description: error
produces:
- text/plain`
type PostBodyModel struct {
John bool `json:"john"`
Betty *string `json:"betty"`
}
type ExampleRequestBundle struct {
Request PostBodyModel `nvelope:"model"`
Bar float64 `nvelope:"path,name=bar"`
Baz string `nvelope:"query,name=baz"`
ContentType string `nvelope:"header,name=Content-Type"`
}
type ExampleResponse struct {
Status interface{} `json:"status,omitempty"`
}
func HandleExampleEndpoint(req ExampleRequestBundle) (nvelope.Response, error) {
resp := ExampleResponse{
Status: 100,
}
if req.Request.John {
resp.Status = "string"
}
return resp, nil
}
func Service(router *mux.Router) {
var v2Doc openapi2.T
err := yaml.Unmarshal([]byte(swagger), &v2Doc)
if err != nil {
panic(fmt.Sprint("yaml", err))
}
v3Doc, err := openapi2conv.ToV3(&v2Doc)
if err != nil {
panic("v3 convert")
}
err = v3Doc.Validate(context.Background())
if err != nil {
panic("v3 validate")
}
requestValidator, responseValidator, err :=
nvalid.OpenAPI3ValidatorFromParsed(v3Doc, "inline", false)
if err != nil {
panic("make validators")
}
encodeJSON := nvelope.MakeResponseEncoder("JSON",
nvelope.WithEncoder("application/json", json.Marshal,
nvelope.WithAPIEnforcer(responseValidator)))
service := nape.RegisterServiceWithMux("example", router)
service.RegisterEndpoint("/foo/{bar}",
// order matters and this is a correct order
nvelope.NoLogger,
nvelope.InjectWriter,
encodeJSON,
nvelope.CatchPanic,
nvelope.Nil204,
nvelope.ReadBody,
requestValidator,
nape.DecodeJSON,
HandleExampleEndpoint,
).Methods("POST")
}
// Example shows an injection chain handling a single endpoint using nject,
// nape, and nvelope.
func Example() {
r := mux.NewRouter()
Service(r)
ts := httptest.NewServer(r)
client := ts.Client()
doPost := func(url string, body string) {
// nolint:noctx
res, err := client.Post(ts.URL+url, "application/json",
strings.NewReader(body))
if err != nil {
fmt.Println("response error:", err)
return
}
b, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println("read error:", err)
return
}
res.Body.Close()
fmt.Println(res.StatusCode, "->"+string(b))
}
fmt.Println("expect valid:")
doPost("/foo/100?baz=j@example.com", `{"john":false,"betty":"Flinstone"}`)
fmt.Println("expect request error:")
doPost("/foo/100", `{"john":false,"betty":"Flinstone"}`) // invalid request
fmt.Println("expect response error:")
doPost("/foo/100?baz=j@example.com", `{"john":true,"betty":"Flinstone"}`)
// Output: expect valid:
// 200 ->{"status":100}
// expect request error:
// 400 ->parameter "baz" in query has an error: value is required but missing
// expect response error:
// 500 ->response body doesn't match schema: Error at "/status": field must be set to integer or not be present
// Schema:
// {
// "type": "integer"
// }
//
// Value:
// "string"
//
//
}