/go-echo-blog

An example CRUD API (for blogging app) using ECHO, Postgres, and Golang. This was a part of a development challenge and was completed within 5 days.

Primary LanguageGo

RUN:

  • Set Environment Variables
export PGSQL_GO_ECHO_BLOG_USER="postgres"
export PGSQL_GO_ECHO_BLOG_PASSWORD="postgres"
export PGSQL_GO_ECHO_BLOG_HOST="localhost"
export PGSQL_GO_ECHO_BLOG_PORT="5432"
  • Create DB using psql command:
CREATE DATABASE "go-echo-blog-db";
  • Create tables:
cd go-echo-blog/src/db/blog/internal/createtable
chmod +x run.sh
./run.sh

cd go-echo-blog/src/db/user/internal/createtable
chmod +x run.sh
./run.sh

cd go-echo-blog/src/db/auth/internal/createtable
chmod +x run.sh
./run.sh
  • Start server:
git clone https://github.com/NavenduDuari/go-echo-blog
cd go-echo-blog
go run main.go

User SignUp:

  • Request:
curl -H "Content-Type: application/json" -X POST http://localhost:8000/public/signup -d '{"phone":"9876543210", "email":"navendu@mail.com", "password":"mypass"}'
  • Response:
"SignUp successful"

User Login:

  • Request:
curl -H "Content-Type: application/json" -X GET http://localhost:8000/public/login -d '{"userid":"9876543210", "password":"mypass"}'
  • Response:
{
  "message": "Login successful!",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZjOTBjZWM4LWE1MDgtMTFlYS05NDk0LTAyNDJhYzExMDAwMiIsInBob25lIjoiOTg3NjU0MzIxMCIsImVtYWlsIjoibmF2ZW5kdUBtYWlsLmNvbSIsImV4cCI6MTU5MTIxMzY1N30.tlw71Alzi9aga6RBFTNIS2ZMEp2AZev1SMCEfdXY5HM"
}

User Login with OTP:

Send OTP:

  • Request:
curl -H "Content-Type: application/json" -X GET http://localhost:8000/public/login-with-otp -d '{"userid":"9876543210"}'
  • Response:
"OTP sent"

Verify OTP:

  • Request:
curl -H "Content-Type: application/json" -X POST http://localhost:8000/public/login-with-otp -d '{"userid":"9876543210", "otp":"9698"}'
  • Response:
{
  "message": "Login successful!",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjRiNTE0MmUwLWFkNTYtMTFlYS04MmYwLTAyNDJhYzExMDAwMiIsInBob25lIjoiOTA2MjgwMDE0MyIsImVtYWlsIjoibmR1YXJpMDlAZ21haWwuY29tIiwiZXhwIjoxNTkyMTMwNTM5fQ.1JmBZw98mYSAuUAzVo2-0dSOn5bujuQ8kNlCJbg4nfM"
}

User Login with QR code:

Get QR code(base64):

  • Request:
curl -H "Content-Type: application/json" -X GET http://localhost:8000/public/login-with-qr -d '{"userid":"9876543210"}'
  • Response:
{
  "message": "Got QR",
  "qrBAse64": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAABlBMVEX///8AAABVwtN+AAABEElEQVR42uzYMZKEIBAF0KYMCD0CR+Fo7NE4ikcgJLD8W9CDO6Kj4W4t/0cz1Iu6oGkUhmGYv54ZmigOedrM628m6IH+DFFE7CoG76tDAQtAQvRICgKQCG6BlB1F8ASWGSC4Aa+z6Ze59qiPh3d00Jp5Ax+7/eBgj1/EYruZE/430KPX3f6J4ATE5gkQ8VhEplLKEN17jyJoAKvRSia7mk3w5Y+lJGiZ6mp0unrecwTazHOdMnUyN7r7DuMBQdftkSxQiiquK/UIoHvSKiW4AD/zpNRKnrYcQf+UQy63Xm1RBA+gFDJcDVoEhzevNnNxBFdg/y7XfvaVHAPsT9r62a3m+tYbHDAMw/xOvgMAAP//e82zVMbJSJIAAAAASUVORK5CYII="
}

Verify Qr code:

  • Request:
curl -H "Content-Type: application/json" -X POST http://localhost:8000/public/login-with-qr -d '{"userid":"9876543210", "qr_code":"YaQTGyF54S"}'
  • Response:
{
  "message": "Login successful!",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQzZTc4OWNhLWFlMDktMTFlYS05YTQ4LTAyNDJhYzExMDAwMiIsInBob25lIjoiOTg3NjU0MzIxMCIsImVtYWlsIjoibmF2ZW5kdUBtYWlsLmNvbSIsImV4cCI6MTU5MjIwNTM5Mn0.L6seLVFvc3xSNCJeXkjethaOwu5rPpwYwJEMFatqhWc"
}

POST Blog:

  • Request:
curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZjOTBjZWM4LWE1MDgtMTFlYS05NDk0LTAyNDJhYzExMDAwMiIsInBob25lIjoiOTg3NjU0MzIxMCIsImVtYWlsIjoibmF2ZW5kdUBtYWlsLmNvbSIsImV4cCI6MTU5MTIxMzY1N30.tlw71Alzi9aga6RBFTNIS2ZMEp2AZev1SMCEfdXY5HM" -H "Content-Type: application/json" -X POST http://localhost:8000/protected/blogs -d '{"title":"This is post title", "body":"this is post body", "categories":["cat1", "cat2"], "tags":["tag1", "tag2"]}'
  • Response:
"Blog POST successful"
  • Request:
curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZjOTBjZWM4LWE1MDgtMTFlYS05NDk0LTAyNDJhYzExMDAwMiIsInBob25lIjoiOTg3NjU0MzIxMCIsImVtYWlsIjoibmF2ZW5kdUBtYWlsLmNvbSIsImV4cCI6MTU5MTIxMzY1N30.tlw71Alzi9aga6RBFTNIS2ZMEp2AZev1SMCEfdXY5HM" -H "Content-Type: application/json" -X POST http://localhost:8000/protected/blogs -d '{"title":"This is another post title", "body":"this is another post body", "categories":["cat1", "cat2"], "tags":["tag1", "tag2"]}'
  • Response:
"Blog POST successful"

GET Blogs:

  • Request:
curl -H "Content-Type: application/json" -X GET http://localhost:8000/public/blogs
  • Response:
{
  "blogs": [
    {
      "id": "0f51d9c8-a50c-11ea-bb4d-0242ac110002",
      "title": "This is post title",
      "body": "this is post body",
      "author": "",
      "timestamp": "2020-06-02T20:03:00.340968Z",
      "categories": [
        "cat1",
        "cat2"
      ],
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    {
      "id": "ac7ba170-a50c-11ea-bb4d-0242ac110002",
      "title": "This is another post title",
      "body": "this is another post body",
      "author": "",
      "timestamp": "2020-06-02T20:07:24.018669Z",
      "categories": [
        "cat1",
        "cat2"
      ],
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ],
  "message": "Blogs FETCH successful!"
}

UPDATE Blogs:

  • Request:
curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZjOTBjZWM4LWE1MDgtMTFlYS05NDk0LTAyNDJhYzExMDAwMiIsInBob25lIjoiOTg3NjU0MzIxMCIsImVtYWlsIjoibmF2ZW5kdUBtYWlsLmNvbSIsImV4cCI6MTU5MTIxMzY1N30.tlw71Alzi9aga6RBFTNIS2ZMEp2AZev1SMCEfdXY5HM" -H "Content-Type: application/json" -X PUT http://localhost:8000/protected/blogs -d '{"id":"0f51d9c8-a50c-11ea-bb4d-0242ac110002", "blog":{"title":"This is updated post title", "body":"this is updated post body", "categories":["cat1", "cat2"], "tags":["tag1", "tag2"]}}
  • Response:
"Blog UPDATE successful"
  • Request:
curl -H "Content-Type: application/json" -X GET http://localhost:8000/public/blogs
  • Response:
{
  "blogs": [
    {
      "id": "ac7ba170-a50c-11ea-bb4d-0242ac110002",
      "title": "This is another post title",
      "body": "this is another post body",
      "author": "",
      "timestamp": "2020-06-02T20:07:24.018669Z",
      "categories": [
        "cat1",
        "cat2"
      ],
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    {
      "id": "0f51d9c8-a50c-11ea-bb4d-0242ac110002",
      "title": "This is updated post title",
      "body": "this is updated post body",
      "author": "",
      "timestamp": "2020-06-02T20:15:31.937391Z",
      "categories": [
        "cat1",
        "cat2"
      ],
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ],
  "message": "Blogs FETCH successful!"
}

DELETE Blogs:

  • Request:
curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZjOTBjZWM4LWE1MDgtMTFlYS05NDk0LTAyNDJhYzExMDAwMiIsInBob25lIjoiOTg3NjU0MzIxMCIsImVtYWlsIjoibmF2ZW5kdUBtYWlsLmNvbSIsImV4cCI6MTU5MTIxMzY1N30.tlw71Alzi9aga6RBFTNIS2ZMEp2AZev1SMCEfdXY5HM" -H "Content-Type: application/json" -X DELETE http://localhost:8000/protected/blogs/ac7ba170-a50c-11ea-bb4d-0242ac110002
  • Response:
"Blog DELETE successful"
  • Request:
curl -H "Content-Type: application/json" -X GET http://localhost:8000/public/blogs
  • Response:
{
  "blogs": [
    {
      "id": "0f51d9c8-a50c-11ea-bb4d-0242ac110002",
      "title": "This is updated post title",
      "body": "this is updated post body",
      "author": "",
      "timestamp": "2020-06-02T20:15:31.937391Z",
      "categories": [
        "cat1",
        "cat2"
      ],
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ],
  "message": "Blogs FETCH successful!"
}

TODO

  • Remove redundant code
  • return consistent HTTP status code
  • Cleanup
  • Edit README
  • Handle if record not found in db