Apigateway is a api-gateway server demo written in golang and go-gin. It features a simple and better performance, you can faster build your api server by this templete. If you need fast build a api gateway server, you will love Apigateway.
start mongo db in your localhost, and update your mongodb info in /conf/app.conf.yml.You also can select mysql.
- Init workdir
git clone https://github.com/nightlegend/apigateway.git
go get github.com/kardianos/govendor
cd $GOPATH/src/github.com/nightlegend/apigateway
export GO111MODULE=on
go get- Start APIGATEWAY
# start with default
go run server.go
# -env: current for enable/disable debug model.
go run server.go -env developmentIf running normally, you can accesshttp://localhost:8080
Application details
-
Server starting from server.go
package main import ( "flag" "os" log "github.com/Sirupsen/logrus" "github.com/nightlegend/apigateway/core/router" ) var ( env = flag.String("env", "development", "running environment") ) // Api server start from here. router is define your api router and public it. func main() { flag.Parse() // set golable logs file path. execDirAbsPath, _ := os.Getwd() f, err := os.OpenFile(execDirAbsPath+"/logs/app.log", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644) if err != nil { log.Fatal(err) } //defer to close when you're done with it, not because you think it's idiomatic! defer f.Close() //set output of logs to file log.SetOutput(f) // start api server, *env is what`s environment will running, currentlly this only for enable or disable debug modle // After may be use it load different varible. router.Start(*env) }
-
Project code structure
folder content cmd command-line tool conf put some application configure to here core put core sources to here(api, grpc, etc) middleware put middleware code to here, like cors logs here will save console log vendor here is save third party doc here is save some document about project -
Router define
Router, It`s like your application gate, help you dispatch all request to target service.
go to apigateway/core/router/router.go, you can define your router.
func Start(env string) { // running mode switcher switch env { case "development": gin.SetMode(gin.DebugMode) default: gin.SetMode(gin.ReleaseMode) } router := gin.New() router.Use(middleware.CORSMiddleware()) router.Use(gin.Logger()) //No Permission Validation public.APIRouter(router) //Permission Validation private.APIRouter(router) router.Run(LisAddr) }
-
Sample api
login api: http://localhost:8080/login
request: POST /login HTTP/1.1 Host: localhost:8080 Content-Type: application/json Cache-Control: no-cache Postman-Token: a70f71a7-72b9-4106-9bcd-fd2b65be1e87 { "userName": "demouser02", "password": "Password1" } response: { "Message": "Login Successful", "code": 200, "tooken": "" }router code implement
router.POST("/login", func(c *gin.Context) { c.BindJSON(&uis) /* // TO-DO: cache user login session. session := sessions.Default(c) if session.Get(uis.USERNAME) == nil { flag = uis.Login() session.Set(uis.USERNAME, uis.USERNAME) session.Save() log.Println("Try login and save session in session store.") } else { flag = consts.SUCCESS log.Println("Have a session in session store.") } */ flag = uis.Login() switch flag { case consts.SUCCESS: c.JSON(http.StatusOK, gin.H{"code": consts.SUCCESS, "Message": "Login Successful", "tooken": ""}) case consts.NOACCOUNT: c.JSON(http.StatusOK, gin.H{"code": consts.NOACCOUNT, "Message": "Not found your account"}) case consts.SYSERROR: c.JSON(http.StatusOK, gin.H{"code": consts.SYSERROR, "Message": "System error!!!"}) case consts.WRONGPASSWD: c.JSON(http.StatusOK, gin.H{"code": consts.WRONGPASSWD, "Message": "Wrong password..."}) } })
CMD
Add command tools for download template code file, later may be add new feature to here.
-
Build runnable file on your OS.
cd apigateway/cmd go build gga.go -
Usage about gga.
when you build complete, you can run excuteable file in command line tools:
> gga A cool tools about init a project, It is can help you do some base thing Usage: gga [command] Available Commands: clone clone sample code to your path. help Help about any command Flags: -h, --help help for gga Use "gga [command] --help" for more information about a command. > gga clone demo
-
CMD Implements.
go get "github.com/spf13/cobra"
// **key code** // newCmd is new commmand tools. And define all sub-command. func (n *newProject) newCmd() *cobra.Command { // root command cmd := &cobra.Command{ Use: "gga [command]", Short: "A very helpful command line tools about apigateway", Long: `A cool tools about init a project, It is can help you do some base thing`, } // gga new [path+filename] cmdNewProject := &cobra.Command{ Use: "clone [path+filename]", Short: "clone sample code to your path.", Long: `Create a new content file. It will guess which kind of file to create based on the path provided.`, RunE: n.downloadFile, } // add sub-command to root command cmd.AddCommand(cmdNewProject) return cmd } func main() { n := &newProject{} n.newCmd().Execute() }
GRPC
Implement grpc function, A high performance, open-source universal RPC framework
-
How to start grpc whith go? GRPC-go-guideline
-
How to enable grpc?
Go to server.go, you will saw below sample code, if don`t want enable it, you can comment it.
go func() { lis, err := net.Listen("tcp", fmt.Sprintf("0.0.0.0:%d", 10000)) if err != nil { log.Fatalf("failed to listen: %v", err) } var opts []grpc.ServerOption grpcServer := grpc.NewServer(opts...) pb.RegisterRouteGuideServer(grpcServer, mgrpc.NewServer()) grpcServer.Serve(lis) }()
-
About grpc here For now, It`s just a sample code, and export an api to testing.
-
GRPC-go environment by docker If you want a generate grpc code env, you can go to here.
Related project
If you need a frond-end template, It`s will be help you.
If you need a SOCKET-SERVER, It`s can help you.
If you interest grpc, I am happy to give a sample to you, GRPC-GO, hope you love it, thanks.