This is my folder structure under my $GOPATH or $HOME/your_username/go.
.
|-- bin
+-- src
| +-- github.com
| | +-- gamorvi
| | | +-- restapi2
| | | | |-- .env
| | | | |-- main.go
| | | | |-- server.go
| | | | |-- .gitignore.go
| | | | |-- README.md
| | | | +-- app
| | | | | +-- controllers
| | | | | | |-- usersController.go
| | | | | +-- auth
| | | | | | |-- authController.go
| | | | +-- models
| | | | | |-- base.go
| | | | | |-- user.go
| | | | +-- routes
| | | | | |-- api.go
| | | | +-- utils
| | | | | |-- utils.go
Ensure you create the gamorvi directory in your github.com directory. cd into the gamorvi directory before git clone https://github.com/gamorvi/restful-api-with-golang.git
Run the following Golang commands to install all the necessary packages. These packages will help you set up a web server, ORM for interacting with your db, mysql driver for db connection, load your environment variables from the .env file and generate JWT tokens.
go get -u github.com/gorilla/mux
go get -u github.com/jinzhu/gorm
go get -u github.com/go-sql-driver/mysql
go get -u github.com/joho/godotenv
go get -u github.com/dgrijalva/jwt-go
For offline documentation on the following packages run godoc -http :6060 and then visit http://localhost:6060. Note that you can change the port to your preferred port number.
Create a .env file in the root of the project and set the following parameters
db_name = database_name # Name of database
db_user = user # Database username
db_pass = secret # Database password
db_type = mysql # MySQL driver
db_host = localhost # Database host
db_port = 3306 # Database port
charset = utf8 # Database charset
parse_time = True # Database parse time
web_port = 8085 # Port to serve api
prefix = /api/v1 # API route sub route prefix
# jwt config
access_token_expire = # in minutes, default is 15 minutes if no value is passed
# this is not used yet as I haven't implemented refresh tokens yet # TODO
refresh_token_expire = 72 # in hours, default is 48 minutes if no value is passed
go run *.go
Use the following DDL (Data Definition Language) to create the users table.
CREATE TABLE `users` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(255) DEFAULT NULL,
`username` varchar(255) DEFAULT NULL,
`password` varchar(255) DEFAULT NULL,
`created_at` datetime DEFAULT NULL,
`updated_at` datetime DEFAULT NULL,
`deleted_at` datetime DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=19 DEFAULT CHARSET=utf8;To be able to login, you need to use the create new user endpoint to set up a user account.
- POST
api/v1/loginlogin with username and password in your db to get token back - POST
api/v1/registercreate a new account with a username, password and name - GET
api/v1/usersretrieve all users - GET
api/v1/users/1retrieve user with id = 1 - POST
api/v1/userscreate a new user - PUT
api/v1/users/1update the record with id = 1 - DELETE
api/v1/users/1delete the user with id = 1
- POST
api/v1/register
{
"Name": "Joe Bloke",
"Username": "[email protected]",
"Password": "secret"
}
*** Output ***
Note that the current implementation still returns the encrypted password, this needs to be removed from the response.
{
"message": "success",
"status": true,
"user": {
"ID": 1,
"CreatedAt": "2019-05-06T00:54:22.09382+01:00",
"UpdatedAt": "2019-05-06T00:54:22.09382+01:00",
"DeletedAt": null,
"Name": "Joe Bloke",
"Username": "[email protected]"
}
}
- POST
api/v1/login
*** Input ***
{
"Username": "[email protected]"
"Password": "secret"
}
*** Output ***
{
"data": {
"access-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjkwMDAwMDAwMDAwMCwicGFzc3dvcmQiOiJzZWNyZXQiLCJ1c2VybmFtZSI6ImFtYXZpQHh5ei5jb20ifQ.WJ5VMnH5ijHQOZhUlrrnrh7NCYfFpww3jBz26EkRsHQ"
},
"message": "success",
"status": true
}
Now make all calls pass the token in the header as a Bearer Token.
The payload portion (2nd part) of the token can be decode as it is base 64 encoded.
echo eyJleHAiOjkwMDAwMDAwMDAwMCwicGFzc3dvcmQiOiJzZWNyZXQiLCJ1c2VybmFtZSI6ImFtYXZpQHh5ei5jb20ifQ | base64 -D
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent