-
Notifications
You must be signed in to change notification settings - Fork 0
/
goapi.go
331 lines (300 loc) · 9.12 KB
/
goapi.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
323
324
325
326
327
328
329
330
331
package goapi
import (
"fmt"
"github.com/goodluckxu-go/goapi/lang"
"github.com/goodluckxu-go/goapi/openapi"
"github.com/goodluckxu-go/goapi/response"
"github.com/goodluckxu-go/goapi/swagger"
json "github.com/json-iterator/go"
"log"
"net/http"
"os"
"strconv"
"strings"
)
// GoAPI It is a newly created API function
func GoAPI(isDocs bool, docsPath ...string) *API {
dPath := "/docs"
if len(docsPath) > 0 {
dPath = docsPath[0]
}
return &API{
isDocs: isDocs,
OpenAPIInfo: &openapi.Info{
Title: "GoAPI",
Version: "1.0.0",
},
Swagger: swagger.Config{
DocExpansion: "list",
DeepLinking: true,
},
log: &levelHandleLogger{log: &defaultLogger{}},
docsPath: dPath,
addr: ":8080",
lang: &lang.EnUs{},
structTagVariableMap: map[string]any{},
}
}
type API struct {
handlers []any
httpExceptionResponse Response
responseMediaTypes []MediaType
OpenAPIInfo *openapi.Info
isDocs bool
OpenAPIServers []*openapi.Server
OpenAPITags []*openapi.Tag
Swagger swagger.Config
docsPath string
exceptFunc func(httpCode int, detail string) Response
lang Lang
log Logger
addr string
routers []*appRouter
structTagVariableMap map[string]any
}
// HTTPExceptionHandler It is an exception handling registration for HTTP
func (a *API) HTTPExceptionHandler(f func(httpCode int, detail string) Response) {
a.httpExceptionResponse = f(0, "")
a.exceptFunc = f
}
// SetLang It is to set the validation language function
func (a *API) SetLang(lang Lang) {
a.lang = lang
}
// SetLogger It is a function for setting custom logs
func (a *API) SetLogger(log Logger) {
a.log = &levelHandleLogger{log: log}
}
// Logger It is a method of obtaining logs
func (a *API) Logger() Logger {
return a.log
}
// SetResponseMediaType It is a function that sets the return value type
func (a *API) SetResponseMediaType(mediaTypes ...MediaType) {
m := map[MediaType]struct{}{}
for _, v := range a.responseMediaTypes {
m[v] = struct{}{}
}
for _, v := range mediaTypes {
if _, ok := m[v]; ok {
continue
}
m[v] = struct{}{}
a.responseMediaTypes = append(a.responseMediaTypes, v)
}
}
// SetStructTagVariableMapping It is set struct tag variable mapping
// example:
//
// summary.UserId: Replace when representing the value {{UserId}} of tag summary
// desc.UserName: Replace when representing the value {{UserName}} of tag desc
func (a *API) SetStructTagVariableMapping(m map[string]string) {
for k, v := range m {
idx := strings.Index(k, ".")
if idx == -1 {
log.Fatal("the struct tag variable mapping key prefix must be in 'summary', 'desc'")
}
tagName := k[:idx]
if !inArray(tagName, tagVariableNames) {
log.Fatal("the struct tag variable mapping key prefix '" + tagName + "' is not in 'summary', 'desc'")
}
a.structTagVariableMap[k] = v
}
}
// AddMiddleware It is a function for adding middleware
func (a *API) AddMiddleware(middlewares ...Middleware) {
for _, middleware := range middlewares {
a.handlers = append(a.handlers, middleware)
}
}
// IncludeRouter It is a function that introduces routing structures
func (a *API) IncludeRouter(router any, prefix string, isDocs bool, middlewares ...Middleware) {
a.handlers = append(a.handlers, &includeRouter{
router: router,
prefix: prefix,
isDocs: isDocs,
middlewares: middlewares,
})
}
// IncludeGroup It is an introduction routing group
func (a *API) IncludeGroup(group *APIGroup) {
a.handlers = append(a.handlers, group)
}
// IncludeChildAPI It is an introduction routing children
func (a *API) IncludeChildAPI(child *ChildAPI) {
a.handlers = append(a.handlers, child)
}
// DebugPprof Open the system's built-in pprof
func (a *API) DebugPprof() {
a.handlers = append(a.handlers, &includeRouter{
router: &pprofInfo{},
prefix: "/debug",
isDocs: false,
})
}
// Static serves files from the given file system root.
func (a *API) Static(path, root string) {
a.handlers = append(a.handlers, &staticInfo{
path: path,
root: root,
})
}
// Run attaches the router to a http.Server and starts listening and serving HTTP requests.
// It is a shortcut for http.ListenAndServe(addr, router)
// Note: this method will block the calling goroutine indefinitely unless an error happens.
func (a *API) Run(addr ...string) (err error) {
if len(addr) > 0 {
a.addr = addr[0]
}
httpHandler := a.Handler()
a.log.Info("GoAPI running on http://%v (Press CTRL+C to quit)", a.addr)
return http.ListenAndServe(a.addr, httpHandler)
}
// RunTLS attaches the router to a http.Server and starts listening and serving HTTPS (secure) requests.
// It is a shortcut for http.ListenAndServeTLS(addr, certFile, keyFile, router)
// Note: this method will block the calling goroutine indefinitely unless an error happens.
func (a *API) RunTLS(addr, certFile, keyFile string) (err error) {
a.addr = addr
httpHandler := a.Handler()
a.log.Info("GoAPI running on http://%v (Press CTRL+C to quit)", a.addr)
return http.ListenAndServeTLS(a.addr, certFile, keyFile, httpHandler)
}
// Handler Return to http.Handler interface
func (a *API) Handler() http.Handler {
a.init()
handle := newHandler(a)
handle.Handle()
if a.isDocs {
apiMap := newHandlerOpenAPI(a, handle).Handle()
for docsPath, api := range apiMap {
openapiBody, _ := json.Marshal(api)
list := swagger.GetSwagger(docsPath, api.Info.Title, logo, openapiBody, a.Swagger)
for _, v := range list {
a.routers = append(a.routers, a.handleSwagger(v, handle.defaultMiddlewares))
}
}
}
serverHandler := newHandlerServer(a, handle)
serverHandler.Handle()
pid := strconv.Itoa(os.Getpid())
if isDefaultLogger(a.log) {
pid = colorDebug(pid)
}
a.log.Info("Started server process [%v]", pid)
a.log.Debug("All routes:")
maxMethodLen := 0
maxPathLen := 0
for _, v := range a.routers {
if maxMethodLen < len(v.method) {
maxMethodLen = len(v.method)
}
if maxPathLen < len(v.path) {
maxPathLen = len(v.path)
}
}
for _, v := range a.routers {
a.log.Debug("%v%v--> %v", spanFill(v.method, len(v.method), maxMethodLen+1), spanFill(v.path, len(v.path), maxPathLen+1), v.pos)
}
return serverHandler.HttpHandler()
}
func (a *API) handleSwagger(router swagger.Router, middlewares []Middleware) *appRouter {
return &appRouter{
path: router.Path,
method: http.MethodGet,
handler: func(ctx *Context) {
ctx.middlewares = middlewares
ctx.log = a.log
ctx.middlewares = append(ctx.middlewares, func(ctx *Context) {
router.Handler(ctx.Writer, ctx.Request)
})
ctx.Next()
},
pos: fmt.Sprintf("github.com/goodluckxu-go/goapi/swagger.GetSwagger (%v Middleware)", len(middlewares)),
}
}
func (a *API) init() {
if len(a.responseMediaTypes) == 0 {
a.responseMediaTypes = []MediaType{JSON}
}
if a.exceptFunc == nil {
a.exceptFunc = func(httpCode int, detail string) Response {
return &response.HTTPResponse[any]{
HttpCode: httpCode,
Body: detail,
}
}
a.httpExceptionResponse = a.exceptFunc(0, "")
}
}
type Middleware func(ctx *Context)
type APIGroup struct {
prefix string
isDocs bool
handlers []any
}
// NewGroup It is a newly created APIGroup function
func NewGroup(prefix string, isDocs bool) *APIGroup {
return &APIGroup{
prefix: prefix,
isDocs: isDocs,
}
}
// AddMiddleware It is a function for adding middleware
func (g *APIGroup) AddMiddleware(middlewares ...Middleware) {
for _, middleware := range middlewares {
g.handlers = append(g.handlers, middleware)
}
}
// IncludeRouter It is a function that introduces routing structures
func (g *APIGroup) IncludeRouter(router any, prefix string, isDocs bool, middlewares ...Middleware) {
g.handlers = append(g.handlers, &includeRouter{
router: router,
prefix: prefix,
isDocs: isDocs,
middlewares: middlewares,
})
}
// IncludeGroup It is an introduction routing group
func (g *APIGroup) IncludeGroup(group *APIGroup) {
g.handlers = append(g.handlers, group)
}
type ChildAPI struct {
prefix string
isDocs bool
docsPath string
OpenAPIInfo *openapi.Info
OpenAPIServers []*openapi.Server
OpenAPITags []*openapi.Tag
handlers []any
}
// NewChildAPI It is a newly created ChildAPI function
func NewChildAPI(prefix string, isDocs bool, docsPath string) *ChildAPI {
return &ChildAPI{
prefix: prefix,
isDocs: isDocs,
docsPath: docsPath,
OpenAPIInfo: &openapi.Info{
Title: "GoAPI",
Version: "1.0.0",
},
}
}
// AddMiddleware It is a function for adding middleware
func (c *ChildAPI) AddMiddleware(middlewares ...Middleware) {
for _, middleware := range middlewares {
c.handlers = append(c.handlers, middleware)
}
}
// IncludeRouter It is a function that introduces routing structures
func (c *ChildAPI) IncludeRouter(router any, prefix string, isDocs bool, middlewares ...Middleware) {
c.handlers = append(c.handlers, &includeRouter{
router: router,
prefix: prefix,
isDocs: isDocs,
middlewares: middlewares,
})
}
// IncludeGroup It is an introduction routing group
func (c *ChildAPI) IncludeGroup(group *APIGroup) {
c.handlers = append(c.handlers, group)
}