Skip to content

Latest commit

 

History

History
183 lines (148 loc) · 3.74 KB

README.md

File metadata and controls

183 lines (148 loc) · 3.74 KB
Raw

go-crud-twirp

A simple CRUD API in go using twirp with storage on postgreSQL

Install Dependencies

Make sure local PostgreSQL database is running. Then Run,

go mod tidy

Generate CRUD API interface, client and server

make proto

Run the Server

make server

Run the Client

make client

Testing the endpoints

Using Protobuf

GET Albums 
echo  \
    | protoc --encode twirpAPI.GetAlbumsReq ./rpc/twirpAPI/twirp.proto \
    | curl -s --request POST \
      --header "Content-Type: application/protobuf" \
      --data-binary @- \
      http://localhost:8080/twirp/twirpAPI.TwirpAPI/GetAlbums \
    | protoc --decode twirpAPI.GetAlbumsResp  ./rpc/twirpAPI/twirp.proto
GetAlbumByID 
echo  'id:2' \
    | protoc --encode twirpAPI.GetAlbumByIDReq ./rpc/twirpAPI/twirp.proto \
    | curl -s --request POST \
      --header "Content-Type: application/protobuf" \
      --data-binary @- \
      http://localhost:8080/twirp/twirpAPI.TwirpAPI/GetAlbumByID \
    | protoc --decode twirpAPI.GetAlbumByIDResp  ./rpc/twirpAPI/twirp.proto
Post Album 
echo  'title:"Invinsible",artist:"Paul Oakenfold",price:19' \
    | protoc --encode twirpAPI.PostAlbumsReq ./rpc/twirpAPI/twirp.proto \
    | curl -s --request POST \
      --header "Content-Type: application/protobuf" \
      --data-binary @- \
      http://localhost:8080/twirp/twirpAPI.TwirpAPI/PostAlbums \
    | protoc --decode twirpAPI.PostAlbumsResp  ./rpc/twirpAPI/twirp.proto
Delete Album 
echo 'id:9' \
    | protoc --encode twirpAPI.DeleteAlbumByIDReq ./rpc/twirpAPI/twirp.proto \
    | curl -s --request POST \
      --header "Content-Type: application/protobuf" \
      --data-binary @- \
      http://localhost:8080/twirp/twirpAPI.TwirpAPI/DeleteAlbumByID \
    | protoc --decode twirpAPI.DeleteAlbumByIDResp  ./rpc/twirpAPI/twirp.proto
Update Album By ID 
echo  'id:12,title:"Going Home",artist:"Drake",price:45' \
    | protoc --encode twirpAPI.UpdateAlbumByIDReq ./rpc/twirpAPI/twirp.proto \
    | curl -s --request POST \
      --header "Content-Type: application/protobuf" \
      --data-binary @- \
      http://localhost:8080/twirp/twirpAPI.TwirpAPI/UpdateAlbumByID \
    | protoc --decode twirpAPI.UpdateAlbumByIDResp  ./rpc/twirpAPI/twirp.proto

Using JSON

GET Albums 
curl --request "POST" \
    --header "Content-Type: application/json" \
    --data '{}' \
    http://localhost:8080/twirp/twirpAPI.TwirpAPI/GetAlbums
GET Album By ID 
curl --request "POST" \
    --header "Content-Type: application/json" \
    --data '{"id": "5"}' \
    http://localhost:8080/twirp/twirpAPI.TwirpAPI/GetAlbumByID
POST an Album 
curl --request "POST" \
    --header "Content-Type: application/json" \
    --data '{"title": "Sunrise","artist": "Tiesto","price": 9}' \
    http://localhost:8080/twirp/twirpAPI.TwirpAPI/PostAlbums
DELETE Album By ID 
curl --request "POST" \
    --header "Content-Type: application/json" \
    --data '{"id": "1"}' \
    http://localhost:8080/twirp/twirpAPI.TwirpAPI/DeleteAlbumByID
UPDATE Album By ID 
curl --request "POST" \
    --header "Content-Type: application/json" \
    --data '{"id": "5", "title": "Legend","artist": "Sidhu Moosewala","price": 79}' \
    http://localhost:8080/twirp/twirpAPI.TwirpAPI/UpdateAlbumByID