-
Notifications
You must be signed in to change notification settings - Fork 156
/
README.MD
65 lines (52 loc) · 5.99 KB
/
README.MD
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
# A simple user API service
## Installation
### 1. You need a go development environment setup before everything starts taking off.
### 2. Use `git clone` to clone the repo to your local folder.
```
git clone https://github.com/gogf/gf-demo-user
```
### 3. Import `manifest/sql/create.sql` to your database.
### 4. Update `manifest/config/config.yaml` according to your local configurations if necessary.
### 5. Run command `go run main.go`, and you'll see something as follows if success:
```
ADDRESS | METHOD | ROUTE | HANDLER | MIDDLEWARE
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | ALL | /* | github.com/gogf/gf/v2/net/ghttp.internalMiddlewareServerTracing | GLOBAL MIDDLEWARE
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | ALL | /* | github.com/gogf/gf/v2/net/ghttp.MiddlewareHandlerResponse | GLOBAL MIDDLEWARE
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | ALL | /api.json | github.com/gogf/gf/v2/net/ghttp.(*Server).openapiSpec |
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | ALL | /swagger/* | github.com/gogf/gf/v2/net/ghttp.(*Server).swaggerUI | HOOK_BEFORE_SERVE
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | POST | /user/check-nick-name | github.com/gogf/gf-demo-user/v2/internal/controller/user.(*Controller).CheckNickName | service.IMiddleware.Ctx
| | | | ghttp.MiddlewareCORS
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | POST | /user/check-passport | github.com/gogf/gf-demo-user/v2/internal/controller/user.(*Controller).CheckPassport | service.IMiddleware.Ctx
| | | | ghttp.MiddlewareCORS
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | POST | /user/is-signed-in | github.com/gogf/gf-demo-user/v2/internal/controller/user.(*Controller).IsSignedIn | service.IMiddleware.Ctx
| | | | ghttp.MiddlewareCORS
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | GET | /user/profile | github.com/gogf/gf-demo-user/v2/internal/controller/user.(*Controller).Profile | service.IMiddleware.Ctx
| | | | ghttp.MiddlewareCORS
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | GET | /user/profile | github.com/gogf/gf-demo-user/v2/internal/controller/user.(*Controller).Profile | service.IMiddleware.Ctx
| | | | ghttp.MiddlewareCORS
| | | | service.IMiddleware.Auth
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | POST | /user/sign-in | github.com/gogf/gf-demo-user/v2/internal/controller/user.(*Controller).SignIn | service.IMiddleware.Ctx
| | | | ghttp.MiddlewareCORS
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | POST | /user/sign-out | github.com/gogf/gf-demo-user/v2/internal/controller/user.(*Controller).SignOut | service.IMiddleware.Ctx
| | | | ghttp.MiddlewareCORS
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
:8000 | POST | /user/sign-up | github.com/gogf/gf-demo-user/v2/internal/controller/user.(*Controller).SignUp | service.IMiddleware.Ctx
| | | | ghttp.MiddlewareCORS
----------|--------|-----------------------|--------------------------------------------------------------------------------------|---------------------------
```
# GoFrame Sites
### GoFrame Repo
* [https://github.com/gogf/gf](https://github.com/gogf/gf)
### GoFrame Home
* [https://goframe.org](https://goframe.org) (中文)