thecodingwhale / go-rest-api

create a simple api for a job posting with jwt authentication

App

• Create a simple api for a job posting with jwt authentication

Goals

• My main goal is to learn golang by creating things like building simple CRUD rest api with jwt.

Run

go build && ./go-rest-api

Test

go test -coverprofile cp.out && go tool cover -html=cp.out

type User struct { Id Email Name Password }

API

POST - /users

body
{
  "email": "[email protected]",
  "name": "John Doe",
  "password": "12345678"
}
response
{}

POST - /authenticate

body
{
  "email": "[email protected]",
  "password": "12345678"
}
response
{
  "token": "token"
}

GET - /jobs?limit=$limit&offset=?$offset

response
[
    {
        "company": "A New World",
        "id": 1,
        "location": "Remote",
        "name": "John Doe",
        "post": "Senior Software Engineer"
    }
]

GET - /jobs/{id:[0-9]+}

response
{
  "id": 2,
  "post": "Senior Software Engineer (Python / Node.js)",
  "location": "Makati City",
  "company": "Lenddo"
}

POST - /jobs

headers:
  Key: Authorization
  Value: Bearer token
body
{
  "post": "Senior Software Engineer",
  "company": "A New World",
  "location": "Remote"
}
response
{}

GET - /test

headers:
  Key: Authorization
  Value: Bearer token
body
{
  "email": "[email protected]",
  "password": "12345678"
}
response
{
  "id": 1,
  "name": "John Doe",
  "email": "[email protected]"
}

Helpful Links

https://www.golang-book.com/books/intro https://astaxie.gitbooks.io/build-web-application-with-golang/content/en/05.2.html https://aligoren.com/golang-get-structtag-values/ https://stackoverflow.com/questions/14514312/obtaining-the-name-of-a-known-struct-field https://stackoverflow.com/questions/18930910/access-struct-property-by-name https://golang.org/src/database/sql/example_test.go http://go-database-sql.org/retrieving.html https://blog.questionable.services/article/http-handler-error-handling-revisited/ https://stackoverflow.com/questions/6012692/os-error-string-value-golang https://medium.com/@sebdah/go-best-practices-error-handling-2d15e1f0c5ee https://gowebexamples.com/password-hashing/ https://github.com/go-ozzo/ozzo-validation https://golangbot.com/learn-golang-series/ https://snippets.aktagon.com/snippets/757-how-to-join-two-tables-with-jmoiron-sqlx http://www.golangprograms.com/go-language/golang-maps.html https://stackoverflow.com/questions/40509575/how-can-i-merge-two-structs-in-golang https://medium.com/code-zen/dynamically-creating-instances-from-key-value-pair-map-and-json-in-go-feef83ab9db2 https://github.com/astaxie/build-web-application-with-golang/blob/master/en/preface.md https://github.com/golang-standards/project-layout https://thenewstack.io/make-a-restful-json-api-go/ https://getstream.io/blog/switched-python-go/ https://stackshare.io/stream/stream-and-go-news-feeds-for-over-300-million-end-users https://www.calhoun.io/updating-and-deleting-postgresql-records-using-gos-sql-package/ https://www.alexedwards.net/blog/practical-persistence-sql https://github.com/qiangxue/golang-restful-starter-kit https://blog.questionable.services/article/testing-http-handlers-go/ https://semaphoreci.com/community/tutorials/building-and-testing-a-rest-api-in-go-with-gorilla-mux-and-postgresql https://getstream.io/blog/switched-python-go/ https://medium.com/@xoen/go-testing-technique-testing-json-http-requests-76d9ce0e11f https://medium.com/@povilasve/go-advanced-tips-tricks-a872503ac859 https://www.alexedwards.net/blog/organising-database-access#using-an-interface