Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kimi0230/gin_graphql
Gin and GraphQL server using Golang, gorm, gqlgen.
https://github.com/kimi0230/gin_graphql
cors-middleware gin go golang gorm gqlgen graphql graphql-server moby publisher-subscriber pubsub swagger
Last synced: about 2 months ago
JSON representation
Gin and GraphQL server using Golang, gorm, gqlgen.
- Host: GitHub
- URL: https://github.com/kimi0230/gin_graphql
- Owner: kimi0230
- License: apache-2.0
- Created: 2021-08-23T02:20:20.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-03-23T06:42:15.000Z (almost 3 years ago)
- Last Synced: 2024-06-21T02:18:38.160Z (7 months ago)
- Topics: cors-middleware, gin, go, golang, gorm, gqlgen, graphql, graphql-server, moby, publisher-subscriber, pubsub, swagger
- Language: Go
- Homepage:
- Size: 25.4 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gin GraphQL
A GraphQL, RESTful server with Golang, [gorm][10], [gqlgen][1], [go-playground/validator][11].
Implement PubSub by [github.com/moby/moby/pkg/pubsub](https://github.com/moby/moby/tree/master/pkg/pubsub) created by Docker.
## Build Server
Copy `.env.example` to `.env` and `.env.dev`
```shell
# create tables
make migrate
# create GraphQL file
make build_graphql
# build server
make build
# start server
.build/gin_graphql
```
### URL
* GraphQL Playground: http://localhost:5566/graphql
* GraphQL Query: http://localhost:5566/graphql/query
---
## Notes
### GraphQL
#### [Schema][6]
* https://graphql.org/learn/schema/
#### [99designs/gqlgen][1]
https://gqlgen.com/
You could initialize a new project using the recommended folder structure by running this command
#### Initiation
```shell
go run github.com/99designs/gqlgen init
```
```
├── go.mod
├── go.sum
├── gqlgen.yml - The gqlgen config file, knobs for controlling the generated code.
├── graph
│ ├── generated - A package that only contains the generated runtime
│ │ └── generated.go - DO NOT EDIT !
│ ├── model - A package for all your graph models, generated or otherwise
│ │ └── models_gen.go - DO NOT EDIT !
│ ├── resolver.go - The root graph resolver type. This file wont get regenerated
│ ├── schema.graphqls - Some schema. You can split the schema into as many graphql files as you like
│ └── schema.resolvers.go - the resolver implementation for schema.graphql
└── server.go - The entry point to your app. Customize it however you see fit
```
#### Finishing touches
At the top of our resolver.go, between package and import, add the following line:
``` go
//go:generate go run github.com/99designs/gqlgen
```
This magic comment tells go generate what command to run when we want to regenerate our code.
To run go generate recursively over your entire project, use this command:`go generate ./...`
#### Implement the directive
##### Declare it in the schema
Path: `graph/schema.graphqls`.
```Graphql
type Mutation {
deleteMeetUp(id: ID!): Boolean! @hasRole(role: ADMIN) @isAuthenticated
}
directive @isAuthenticated on FIELD_DEFINITION
directive @hasRole(role: Role!) on FIELD_DEFINITION
```
##### Implement
Path: `graph/directives/directiveAuth.go`
```go
func IsAuthenticated(ctx context.Context, obj interface{}, next graphql.Resolver) (res interface{}, err error) {
ctxUserID := ctx.Value(CurrentUserKey)
if ctxUserID == nil {
return nil, graph.ErrUnauthenticated
}
return next(ctx)
}
```
##### Pass it in when start server
Path: `main.go`
```go
c := generated.Config{Resolvers: &graph.Resolver{}}
// Schema Directive
c.Directives.IsAuthenticated = directives.IsAuthenticated
c.Directives.HasRole = directives.HasRole
srv := handler.NewDefaultServer(generated.NewExecutableSchema(c))
return func(c *gin.Context) {
srv.ServeHTTP(c.Writer, c.Request)
}
```
#### Modify schema
1. modify your schema `graph/schema.graphqls`
2. run gqlgen `./script/gqlgen.sh` or `go run -v github.com/99designs/gqlgen`
3. modify resolvers `graph/resolver.go`
---
### Database (Mysql)
#### Migrate
`make migrate mode={auto | drop | refresh}` or `go run database/migrate.go -m=auto`
---
### Swagger API Doc
http://localhost:5566/swagger/index.html
##### init
`swag init`
### PPROF
```shell
[GIN-debug] GET /admin/pprof/ --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
[GIN-debug] GET /admin/pprof/cmdline --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
[GIN-debug] GET /admin/pprof/profile --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
[GIN-debug] POST /admin/pprof/symbol --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
[GIN-debug] GET /admin/pprof/symbol --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
[GIN-debug] GET /admin/pprof/trace --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
[GIN-debug] GET /admin/pprof/allocs --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
[GIN-debug] GET /admin/pprof/block --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
[GIN-debug] GET /admin/pprof/goroutine --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
[GIN-debug] GET /admin/pprof/heap --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
[GIN-debug] GET /admin/pprof/mutex --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
[GIN-debug] GET /admin/pprof/threadcreate --> github.com/gin-contrib/pprof.pprofHandler.func1 (4 handlers)
```
---
### Go commands
```shell
# Initiation Go project
go mod init
go mod tidy
# download Go package
go mod download
```
---
### Fix
1. `graph/prelude.resolvers.go:19:34: cannot refer to unexported name generated.__DirectiveResolver`
* rollback the version of gqlparser from github.com/vektah/gqlparser/v2 v2.2.0 to github.com/vektah/gqlparser/v2 v2.1.0
```
go mod edit -require github.com/vektah/gqlparser/[email protected]
go clean -i github.com/vektah/gqlparser/v2
go get github.com/vektah/gqlparser/[email protected]
```
* https://github.com/99designs/gqlgen/issues/1402
* https://stackoverflow.com/questions/24855081/how-do-i-import-a-specific-version-of-a-package-using-go-get
* https://github.com/golang/go/issues/44129
---
## Reference
1. [99designs/gqlgen][1]
2. [go.uber.org/ratelimit][2]
3. [didip/tollbooth][3]
4. [EQuimper/youtube-golang-graphql-tutorial][4]
5. [wtlin1228/unasees][5]
6. [schema][6]
7. [gqlgen gin][7]
8. [blog.laisky.com][8]
9. [qlgen-custom-data-validation][9]
10. [gorm][10]
11. [go-playground/validator][11]
12. [graphql-spec][12]
[1]: https://github.com/99designs/gqlgen
"99designs/gqlgen"
[2]: https://pkg.go.dev/go.uber.org/ratelimit
"go.uber.org/ratelimit"
[3]: https://github.com/didip/tollbooth
"didip/tollbooth"
[4]: https://github.com/EQuimper/youtube-golang-graphql-tutorial
"EQuimper/youtube-golang-graphql-tutorial"
[5]: https://github.com/wtlin1228/unasees
"wtlin1228/unasees"
[6]: https://graphql.org/learn/schema/
"schema"
[7]: https://gqlgen.com/recipes/gin/
"gqlgen gin"
[8]: https://blog.laisky.com/p/gqlgen/#%E5%AE%9A%E4%B9%89+schema-Hfxfd
"blog.laisky.com"
[9]: https://david-yappeter.medium.com/gqlgen-custom-data-validation-part-1-7de8ef92de4c
"qlgen-custom-data-validation"
[10]: https://gorm.io/index.html
"gorm"
[11]: https://github.com/go-playground/validator
"go-playground/validator"
[12]: https://github.com/graphql/graphql-spec/blob/main/spec/Section%203%20--%20Type%20System.md#descriptions
"graphql-spec"