hosomi / go-gin-first-step

Go lang & Gin Web Framework first step.

Go lang & Gin Web Framework first step.

🔗 The Go Programming Language
🔗 Gin Web Framework

1. basic start of the first step.

1.1 basic setup

environment:

• Windows10
• PowerShell
• Visual Studio Code 🔗 Visual Studio Code – コード エディター | Microsoft Azure
• Go lang -> msi package(:link: Download and install - The Go Programming Language)

PS > go version
go version go1.15.2 windows/amd64

PS > mkdir go-gin-first-step
PS > cd go-gin-first-step

PS go-gin-first-step> go mod init gin_test
go: creating new go.mod: module gin_test

PS go-gin-first-step> go get -u github.com/gin-gonic/gin
go: downloading github.com/gin-gonic/gin v1.6.3
go: github.com/gin-gonic/gin upgrade => v1.6.3
go: downloading github.com/gin-contrib/sse v0.1.0
go: downloading github.com/golang/protobuf v1.3.3
go: downloading gopkg.in/yaml.v2 v2.2.8
go: downloading github.com/json-iterator/go v1.1.9
go: downloading github.com/mattn/go-isatty v0.0.12
go: downloading github.com/go-playground/validator/v10 v10.2.0
go: downloading github.com/ugorji/go v1.1.7
go: downloading golang.org/x/sys v0.0.0-20200116001909-b77594299b42
go: downloading github.com/ugorji/go/codec v1.1.7
go: downloading github.com/leodido/go-urn v1.2.0
go: downloading github.com/go-playground/universal-translator v0.17.0
go: downloading github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742
go: downloading github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421
go: downloading github.com/go-playground/locales v0.13.0
go: github.com/modern-go/reflect2 upgrade => v1.0.1
go: github.com/golang/protobuf upgrade => v1.4.2
go: github.com/modern-go/concurrent upgrade => v0.0.0-20180306012644-bacd9c7ef1dd
go: gopkg.in/yaml.v2 upgrade => v2.3.0
go: github.com/go-playground/validator/v10 upgrade => v10.3.0
go: github.com/json-iterator/go upgrade => v1.1.10
go: golang.org/x/sys upgrade => v0.0.0-20200909081042-eff7692f9009
go: downloading gopkg.in/yaml.v2 v2.3.0
go: downloading github.com/json-iterator/go v1.1.10
go: downloading github.com/golang/protobuf v1.4.2
go: downloading github.com/go-playground/validator/v10 v10.3.0
go: downloading golang.org/x/sys v0.0.0-20200909081042-eff7692f9009
go: downloading google.golang.org/protobuf v1.23.0
go: downloading github.com/modern-go/reflect2 v1.0.1
go: downloading github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd
go: google.golang.org/protobuf upgrade => v1.25.0
go: downloading google.golang.org/protobuf v1.25.0

PS go-gin-first-step> code .

1.2 go run

PS go-gin-first-step> go run main.go
[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.

[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
 - using env:   export GIN_MODE=release
 - using code:  gin.SetMode(gin.ReleaseMode)

[GIN-debug] GET    /                         --> main.main.func2 (4 handlers)
[GIN-debug] Loaded HTML Templates (3):
        - fileupload.html
        - index.html
        -

[GIN-debug] GET    /templates                --> main.main.func3 (4 handlers)
[GIN-debug] GET    /static/*filepath         --> github.com/gin-gonic/gin.(*RouterGroup).createStaticHandler.func1 (4 handlers)
[GIN-debug] HEAD   /static/*filepath         --> github.com/gin-gonic/gin.(*RouterGroup).createStaticHandler.func1 (4 handlers)
[GIN-debug] GET    /upload                   --> main.main.func4 (4 handlers)
[GIN-debug] POST   /upload                   --> main.main.func5 (4 handlers)
[GIN-debug] Listening and serving HTTP on :3000

http:localhost:3000 :

path	method	description
/	GET	hello world json
/templates	GET	template hello world
/static/*	GET	engine.Static (http://localhost:3000/static/gin.png) *gin.png
/upload	GET	file upload front
/upload	POST	file upload /images

*gin.png ：:link: gin-gonic/gin: Gin is a HTTP web framework written in Go (Golang). It features a Martini-like API with much better performance -- up to 40 times faster. If you need smashing performance, get yourself some Gin.

---

history :

1. setup
2. hello world! (branch : hello-world)
3. templates (branch : templates)
4. engine static (branch : static)
5. fileupload & here document (branch : file-upload)

basic end.

---

2. first step next REST API configuration.

2.1 setup database

environment:

• MySQL 8.x(docker)

go-gin-first-step
│  docker-compose.yml
│
└─docker
   └─mysql
       │  Dockerfile
       │
       ├─conf.d
       │      my.cnf
       │
       ├─data
       │
       └─initdb.d
              create_db.sql

1. docker-compose up -d
2. docker-compose ps
3. mysql -uroot -prootpassword -h 127.0.0.1 -P 3306

---

logs:

1. docker-compose up -d:

PS go-gin-first-step> docker-compose up -d
Creating network "go-gin-first-step_default" with the default driver
Step 1/2 : FROM mysql:8
8: Pulling from library/mysql
d121f8d1c412: Pull complete
f3cebc0b4691: Pull complete
1862755a0b37: Pull complete
489b44f3dbb4: Pull complete
690874f836db: Pull complete
baa8be383ffb: Pull complete
55356608b4ac: Pull complete
dd35ceccb6eb: Pull complete
429b35712b19: Pull complete
162d8291095c: Pull complete
5e500ef7181b: Pull complete
af7528e958b6: Pull complete
Digest: sha256:e1bfe11693ed2052cb3b4e5fa356c65381129e87e38551c6cd6ec532ebe0e808
Status: Downloaded newer image for mysql:8
 ---> e1d7dc9731da
Step 2/2 : EXPOSE 3306
 ---> Running in 62e45392cc93
Removing intermediate container 62e45392cc93
 ---> 2bd982e2e863

Successfully built 2bd982e2e863
Successfully tagged go-gin-first-step_mysql:latest
WARNING: Image for service mysql was built because it did not already exist. To rebuild this image you must use `docker-compose build` or `docker-compose up --build`.
Creating mysql ... done

2. docker-compose ps:

Name              Command             State                 Ports
-------------------------------------------------------------------------------
mysql   docker-entrypoint.sh mysqld   Up      0.0.0.0:3306->3306/tcp, 3306/tcp

3. mysql -uroot -prootpassword -h 127.0.0.1 -P 3306:

PS go-gin-first-step> mysql -uroot -prootpassword -h 127.0.0.1 -P 3306
mysql: [Warning] Using a password on the command line interface can be insecure.
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 9
Server version: 8.0.21 MySQL Community Server - GPL

Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
| sys                |
| test               |
+--------------------+
5 rows in set (0.01 sec)

mysql> exit
Bye

PS go-gin-first-step>

2.2 packages setup

• mysql package · pkg.go.dev
  go get github.com/go-sql-driver/mysql

• xorm package · pkg.go.dev
  go get github.com/go-xorm/xorm

• zap package · pkg.go.dev
  go get go.uber.org/zap

logs:

PS go-gin-first-step> go get github.com/go-sql-driver/mysql
go: downloading github.com/go-sql-driver/mysql v1.5.0
go: github.com/go-sql-driver/mysql upgrade => v1.5.0
PS go-gin-first-step> go get github.com/go-xorm/xorm
go: downloading github.com/go-xorm/xorm v0.7.9
go: github.com/go-xorm/xorm upgrade => v0.7.9
go: downloading xorm.io/builder v0.3.6
go: downloading xorm.io/core v0.7.2-0.20190928055935-90aeac8d08eb
PS go-gin-first-step> go get go.uber.org/zap
go: downloading go.uber.org/zap v1.16.0
go: go.uber.org/zap upgrade => v1.16.0
go: downloading go.uber.org/atomic v1.6.0
go: downloading go.uber.org/multierr v1.5.0

2.3 folder structur

go-gin-first-step
│  main.go
│
├─controller
│      book.go
│
├─middleware
│      bookMiddleware.go
│
├─model
│      book.go
│
└─service
       book.go
       init.go

2.4 go run

go run main.go :

logs:

PS go-gin-first-step> go run main.go
[xorm] [info]  2020/09/14 11:39:44.722407 [SQL] SELECT `TABLE_NAME`, `ENGINE`, `TABLE_ROWS`, `AUTO_INCREMENT`, `TABLE_COMMENT` from `INFORMATION_SCHEMA`.`TABLES` WHERE `TABLE_SCHEMA`=? AND (`ENGINE`='MyISAM' OR `ENGINE` = 'InnoDB' OR `ENGINE` = 'TokuDB') [test]
[xorm] [info]  2020/09/14 11:39:45.648517 [SQL] CREATE TABLE IF NOT EXISTS `book` (`id` INT(64) PRIMARY KEY AUTO_INCREMENT NOT NULL, `title` VARCHAR(40) NULL, `content` VARCHAR(40) NULL) DEFAULT CHARSET utf8
init data base ok
[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.

[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
 - using env:   export GIN_MODE=release
 - using code:  gin.SetMode(gin.ReleaseMode)

[GIN-debug] GET    /                         --> main.main.func2 (4 handlers)
[GIN-debug] Loaded HTML Templates (3):
        -
        - fileupload.html
        - index.html

[GIN-debug] GET    /templates                --> main.main.func3 (4 handlers)
[GIN-debug] GET    /static/*filepath         --> github.com/gin-gonic/gin.(*RouterGroup).createStaticHandler.func1 (4 handlers)
[GIN-debug] HEAD   /static/*filepath         --> github.com/gin-gonic/gin.(*RouterGroup).createStaticHandler.func1 (4 handlers)
[GIN-debug] GET    /upload                   --> main.main.func4 (4 handlers)
[GIN-debug] POST   /upload                   --> main.main.func5 (4 handlers)
[GIN-debug] POST   /book/v1/add              --> gin_test/controller.BookAdd (5 handlers)
[GIN-debug] GET    /book/v1/list             --> gin_test/controller.BookList (5 handlers)
[GIN-debug] PUT    /book/v1/update           --> gin_test/controller.BookUpdate (5 handlers)
[GIN-debug] DELETE /book/v1/delete           --> gin_test/controller.BookDelete (5 handlers)
[GIN-debug] Listening and serving HTTP on :3000

check /book/v1/ endpoints.

next,
check that a book table is created in the MySQL test database.

PowerShell:

PS> mysql -uroot -prootpassword -h 127.0.0.1 -P 3306

MySQL:

mysql> use test;
mysql> show tables;
mysql> describe book;
mysql> exit;

logs:

PS > mysql -uroot -prootpassword -h 127.0.0.1 -P 3306
mysql: [Warning] Using a password on the command line interface can be insecure.
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 13
Server version: 8.0.21 MySQL Community Server - GPL

Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql> use test;
Database changed
mysql> show tables;
+----------------+
| Tables_in_test |
+----------------+
| book           |
+----------------+
1 row in set (0.00 sec)

mysql> describe book;
+---------+-------------+------+-----+---------+----------------+
| Field   | Type        | Null | Key | Default | Extra          |
+---------+-------------+------+-----+---------+----------------+
| id      | int         | NO   | PRI | NULL    | auto_increment |
| title   | varchar(40) | YES  |     | NULL    |                |
| content | varchar(40) | YES  |     | NULL    |                |
+---------+-------------+------+-----+---------+----------------+
3 rows in set (0.01 sec)

mysql> exit
Bye

2.5 book API tests

path	method	description
/book/v1/add	POST	adding new data to the book
/book/v1/list	GET	retrieve a list of book data
/book/v1/update	PUT	updating the book's data
/book/v1/delete	DELETE	deletion of book data

---

the test is done with cURL(for Windows).
(it is also recommended to refer to the data in your MySQL client.)
🔗 curl for Windows

• POST: /book/v1/add :

PS > ./curl --location --request POST "http://localhost:3000/book/v1/add" --form "title=title" --form "content=content"
{"status":"ok"}

• GET: /book/v1/list :

PS > ./curl --location --request GET "http://localhost:3000/book/v1/list"
{"data":[{"id":1,"title":"title","content":"content"}],"message":"ok"}

• PUT: /book/v1/update :

PS > ./curl --location --request PUT "http://localhost:3000/book/v1/update" --form "id=1" --form "title=title-update" --form "content=content-update"
{"status":"ok"}

• DELETE: /book/v1/delete :

PS > ./curl --location --request DELETE "http://localhost:3000/book/v1/delete" --form  "id=1"
{"status":"ok"}

---

MySQL client reference examples:

PS > mysql -uroot -prootpassword -h 127.0.0.1 -P 3306
mysql: [Warning] Using a password on the command line interface can be insecure.
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 8
Server version: 8.0.21 MySQL Community Server - GPL

Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql> use test;
Database changed
mysql> select * from book;
+----+-------+---------+
| id | title | content |
+----+-------+---------+
|  1 | title | content |
+----+-------+---------+
1 row in set (0.00 sec)