-
Notifications
You must be signed in to change notification settings - Fork 108
/
api.go
322 lines (278 loc) · 8.13 KB
/
api.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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
// SPDX-License-Identifier: MIT
package mock
import (
"fmt"
"io/ioutil"
"net/http"
"strconv"
"strings"
"github.com/issue9/is"
"github.com/issue9/qheader"
"github.com/caixw/apidoc/v7/core"
"github.com/caixw/apidoc/v7/internal/ast"
"github.com/caixw/apidoc/v7/internal/locale"
)
func (m *mock) buildAPI(api *ast.API) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
m.h.Locale(core.Succ, locale.RequestAPI, r.Method, r.URL.Path)
if api.Deprecated != nil {
m.h.Locale(core.Warn, locale.DeprecatedWarn, r.Method, r.URL.Path, api.Deprecated.V())
}
if err := validQueries(api.Path.Queries, r); err != nil {
m.handleError(w, r, "", err)
return
}
for _, header := range api.Headers {
field := "headers[" + header.Name.V() + "]"
if err := validSimpleParam(header, field, r.Header.Get(header.Name.V())); err != nil {
m.handleError(w, r, field, err)
return
}
}
if len(api.Requests) > 0 { // GET、OPTIONS 之类的可能没有 body
if err := validRequest(m.doc.XMLNamespaces, api.Requests, r); err != nil {
m.handleError(w, r, "request.body.", err)
return
}
}
m.renderResponse(api, w, r)
})
}
func validRequest(ns []*ast.XMLNamespace, requests []*ast.Request, r *http.Request) error {
ct := r.Header.Get("Content-Type")
if ct == "" || ct == "*/*" || strings.HasSuffix(ct, "/*") { // 用户提交的 content-type 必须是明确的值
return core.NewError(locale.ErrInvalidValue).WithField("headers[content-type]")
}
req := findRequestByContentType(requests, ct)
if req == nil {
return core.NewError(locale.ErrInvalidValue).WithField("headers[content-type]")
}
for _, header := range req.Headers {
if err := validSimpleParam(header, "headers["+header.Name.V()+"]", r.Header.Get(header.Name.V())); err != nil {
return err
}
}
content, err := ioutil.ReadAll(r.Body)
if err != nil {
return err
}
if err = r.Body.Close(); err != nil {
return err
}
switch ct {
case "application/json":
return validJSON(req, content)
case "application/xml", "text/xml":
return validXML(ns, req, content)
default:
return core.NewError(locale.ErrInvalidValue).WithField("headers[content-type]")
}
}
func (m *mock) renderResponse(api *ast.API, w http.ResponseWriter, r *http.Request) {
accepts, err := qheader.Accept(r)
if err != nil {
m.handleError(w, r, "request.headers[Accept]", err)
return
}
resp, accept := findResponseByAccept(m.doc.Mimetypes, api.Responses, accepts)
if resp == nil {
// 仅在 api.Responses 无法匹配任何内容的时候,才从 doc.Responses 中查找内容
resp, accept = findResponseByAccept(m.doc.Mimetypes, m.doc.Responses, accepts)
if resp == nil {
m.handleError(w, r, "headers[Accept]", locale.NewError(locale.ErrInvalidValue))
return
}
}
data, err := m.buildResponse(resp, r)
if err != nil {
m.handleError(w, r, "response.body.", err)
return
}
w.Header().Set("Content-Type", accept)
w.Header().Set("Server", core.Name)
for _, item := range resp.Headers {
switch primitive, _ := ast.ParseType(item.Type.V()); primitive {
case ast.TypeBool:
w.Header().Set(item.Name.V(), strconv.FormatBool(m.gen.generateBool()))
case ast.TypeNumber:
w.Header().Set(item.Name.V(), fmt.Sprint(m.gen.generateNumber(item)))
case ast.TypeString:
w.Header().Set(item.Name.V(), m.gen.generateString(item))
default:
m.handleError(w, r, "response.headers", locale.NewError(locale.ErrInvalidFormat))
return
}
}
w.WriteHeader(resp.Status.V())
if _, err := w.Write(data); err != nil {
m.h.Error(err) // 此时状态码已经输出
}
}
// 需要保证 ct 的值不能为空
func findRequestByContentType(requests []*ast.Request, ct string) *ast.Request {
var none *ast.Request
for _, req := range requests {
if req.Mimetype.V() == ct {
return req
} else if none == nil && req.Mimetype.V() == "" {
none = req
}
}
if none != nil {
return none
}
return nil
}
// accepts 必须是已经按权重进行排序的。
func findResponseByAccept(mimetypes []*ast.Element, requests []*ast.Request, accepts []*qheader.Header) (*ast.Request, string) {
if len(requests) == 0 {
return nil, ""
}
var none *ast.Request // 表示 requests 中 mimetype 值为空的第一个子项
// 从 requests 中查找是否有符合 accepts 的内容
for _, req := range requests {
if none == nil && req.Mimetype.V() == "" {
none = req
}
if req.Mimetype.V() != "" && matchContentType(req.Mimetype.V(), accepts) {
return req, req.Mimetype.V()
}
}
// 如果存在 none,则从 doc.mimetypes 中查找是否有与 none.Mimetype 相匹配的
if none != nil {
for _, item := range mimetypes {
mt := item.Content.Value
if mt != "" && matchContentType(mt, accepts) {
return none, mt
}
}
}
return nil, ""
}
// 查看 ct 是否有与 accepts 相匹配的项,必须保证 ct 的值不为空。
func matchContentType(ct string, accepts []*qheader.Header) bool {
for _, a := range accepts {
if (strings.HasSuffix(a.Value, "/*") && strings.HasPrefix(ct, a.Value[:len(a.Value)-1])) ||
ct == a.Value ||
a.Value == "*/*" {
return true
}
}
return false
}
// 处理 serveHTTP 中的错误
func (m *mock) handleError(w http.ResponseWriter, r *http.Request, field string, err error) {
// 这并不是一个真实存在的 URI
file := core.URI(r.Method + ": " + r.URL.Path)
if serr, ok := err.(*core.Error); ok {
if serr.Field == "" {
serr.Field = field
} else {
serr.Field = field + serr.Field
}
serr.Location.URI = file
} else {
err = (core.Location{URI: file}).WithError(err).WithField(field)
}
m.h.Error(err)
w.WriteHeader(http.StatusBadRequest)
}
func validQueries(queries []*ast.Param, r *http.Request) error {
for _, query := range queries {
field := "queries[" + query.Name.V() + "]."
valid := func(p *ast.Param, v string) error {
err := validSimpleParam(p, field, v)
if serr, ok := err.(*core.Error); ok {
serr.Field = field + serr.Field
}
return err
}
if !query.Array.V() {
if err := valid(query, r.FormValue(query.Name.V())); err != nil {
return err
}
} else if !query.ArrayStyle.V() { // 默认的 form 格式
if err := r.ParseForm(); err != nil {
return err
}
for _, v := range r.Form[query.Name.V()] {
if err := valid(query, v); err != nil {
return err
}
}
} else {
values := strings.Split(r.FormValue(query.Name.V()), ",")
for _, v := range values {
if err := valid(query, v); err != nil {
return err
}
}
}
}
return nil
}
// 验证单个参数,仅支持对 query、header 等简单类型的参数验证
func validSimpleParam(p *ast.Param, name, val string) error {
if p == nil {
return nil
}
if val == "" && p.Type.V() != ast.TypeString { // 字符串的默认值可以为 “”
if (p.Optional != nil && p.Optional.V()) ||
(p.Default != nil && p.Default.V() != "") {
return nil
}
return core.NewError(locale.ErrIsEmpty, name)
}
switch p.Type.V() {
case ast.TypeBool:
if _, err := strconv.ParseBool(val); err != nil {
return core.NewError(locale.ErrInvalidFormat)
}
case ast.TypeNumber:
if !is.Number(val) {
return core.NewError(locale.ErrInvalidFormat)
}
case ast.TypeString:
case ast.TypeObject:
case ast.TypeNone:
if val != "" {
return core.NewError(locale.ErrInvalidValue)
}
}
if isEnum(p) {
found := false
for _, e := range p.Enums {
if e.Value.V() == val {
found = true
break
}
}
if !found {
return core.NewError(locale.ErrInvalidValue)
}
}
return nil
}
func (m *mock) buildResponse(p *ast.Request, r *http.Request) ([]byte, error) {
if p == nil {
return nil, nil
}
for _, header := range p.Headers {
if err := validSimpleParam(header, "headers["+header.Name.V()+"]", r.Header.Get(header.Name.V())); err != nil {
return nil, err
}
}
headers, err := qheader.Accept(r)
if err != nil {
return nil, err
}
for _, h := range headers {
switch strings.ToLower(h.Value) {
case "application/json", "*/*":
return buildJSON(p, m.indent, m.gen)
case "application/xml", "text/xml":
return buildXML(m.doc.XMLNamespaces, p, m.indent, m.gen)
}
}
return nil, core.NewError(locale.ErrInvalidValue).WithField("headers[accept]")
}