restful_api_with_gin

README

使用gin實現的RESTful API

github.com/limiu82214/GoBasicProject/restful_api_with_gin

使用gin完成restful_api github gin
使用goleveldb作資料庫 v0.0.4 github goleveldb
使用Mysql作為資料庫 v0.1.0 github mysql
使用Gorm作為Mysql的ORM v0.1.0 github gorm
使用Redigo作為redis的工具 v0.1.1 github redigo

規劃

• 接收與返回資料格式皆為JSON
• 使用者新增查詢等功能

Version

v0.0.1 => 實現了pin/pong呼叫
v0.0.2 => 使用GET取回使用者資料 /user/1
v0.0.3 => 使用GET取回使用者資料，可以應對不存在的ID /user/*
v0.0.4 => 使用POST新增使用者資料 /user，使用leveldb來存放user資料
v0.0.5 => 使用gob來儲存user的資料 (將struct放入db、將struct序列化)
v0.0.6 => db改成單例模式，使用signal的方式讓伺服器關閉前可以斷開db連接
v0.0.7 => DELETE 刪除資料 /user/*
v0.0.8 => 整理分類模組
v0.0.9 => user 可以儲存姓名以外的資料
v0.0.10 => 平時使用db_test測試與開發。go run . -production時才會使用正是路徑
v0.1.0 => 導入Mysql使用Gorm
v0.1.1 => 使用docker安裝redis環境，透過redigo使用redis
v0.1.2 => 將mysql也透過docker運行(使用docker-composer.yml docker compose up -d)
v0.1.3 => 使用redis快取GET的資料(使用裝飾器模式)，並分離Service層

RESTful API

• POST user // data 已json的形式帶入 post body
• GET user/*
• PUT 暫不實作
• PATH 暫不實作
• DELETE user/*

return

• 200 ok v0.0.1
• 201 created v0.0.4
• 202 accepted
• 204 no content
• 400 bad request v0.0.4
• 401 unauthorized
• 403 forbidden
• 404 not found
• 410 gone
• 500 internal server error v0.0.4
• 502 bad gateway
• 503 service unavailable
• 504 gateway timeout

Point

• http request 的Test寫法 v0.0.1
• leveldb的使用 v0.0.4
• gob將struct序列化 v0.0.5
• leveldb單例封裝 v0.0.6
• 監聽signal，db連接失敗或重大錯誤時利用signal關閉server v0.0.6

尚未完成項目

• mysql接入，預計使用GORM v0.1.0 ~~ *[ ] mysql與leveldb共用介面，可切換使用~~
• [*] redis接入 (使用docker安裝) v0.1.2 改用docker compose ~~ * $docker build -t test_env . // use Dockerfile v0.1.1 ~~ ~~ * $docker run --name redis_test -d -p 6379:6379 test_env v0.1.1 ~~
• redis快取資料 v0.1.3
• 使用channel來控制測試順序
• docker v0.1.1
• docker 將環境打包在一起，若含程式原始碼則一並打包

有可能會使用的項目

• Clean Architecture
• k8s 微服務
• 建立聊天室，並將聊天室服務與User服務透過k8s分開
• 使用docker佈署測試環境