massad / gin-boilerplate Goto Github PK

The fastest way to deploy a restful api's with Gin Framework with a structured project that defaults to PostgreSQL database and JWT authentication middleware stored in Redis

License: MIT License

Go 86.57% HTML 0.99% PLpgSQL 11.50% Shell 0.93%

gin-framework redis golang postgresql boilerplate-template database gin-boilerplate postman jwt ssl

gin-boilerplate's Introduction

Hi there 👋

🔭 Currently building the awesome mobile app distribution platform

🎉 Some fun facts

since 16 Sep 2021

Are you a mobile app developer? Join our

gin-boilerplate's People

Contributors

Stargazers

Watchers

Forkers

gitter-badger shirone whilei krolow kross77 hiteshjoshi skeleton1231 jamesphe 345161974 mousebb baskaran-r koflazycat georgegg korolr alxerg gfhack lz1988 endyk forging2012 muharihar foryforx kuochaoyi wibin86 newmizanur kgrvamsi awannabecoder ajinoline juniarta syssam dangminhtruong matiasinsaurralde flexboy sankam-nikolya shotu akhamatmk victorkochkarev pavel-anisimov f-naoe connortobrien xdays oktariza thainh h4ck3rk3y wozuo mfrank2016 insung151 vinhhapm zhulinxuezhe123 dedebadru jonham trance- athna wahgh wojciechgl rmp4 mrifkyilyas 0x1a0b haleluak metacloud anthones xiaohe-zhang mrsaeeddev jmyung bhaskuma636 wikieden lospejos najienka wawandx tuantran37 lizihan021 jing-li-rocos maitysubhasis pjcalvo vinimpv nivjain jiaosl marijani101 mariowhowrites guseinovmg 1997arief philjestin aryou filippov0705 ohmaha feobaby datascienceleague branislavlazic abhicoder29 ahmadbudiu neumar kgeonw hongry18 imrannazirbhat minhthong494 vrkkarthi luckspt builder296 developgo leelai eosvn

gin-boilerplate's Issues

Build fails due to myesui/uuid

It looks like the repo https://github.com/myesui/uuid is now missing and https://github.com/twinj/uuid looks to be dependent on it. Thus, some fun errors occur with the modules and when trying to build.

        remote: Repository not found.
        fatal: repository 'https://github.com/myesui/uuid/' not found

An easy solution seems to be replacing https://github.com/twinj/uuid with https://github.com/google/uuid which has the same functionality.

If the user is logged out, someone else can take the token and use it to fetch the details about user.

You have deleted user token from redis store but the token is still valid(authorized=true), it is not invalidated. In middleware you are only checking if the token is authorized or not.

How to actually run the app

So, I installed the database and everything, and it's connected, but there doesn't seem to be any UI...is that an exercise left to the reader?

Doesnt hit the create article endpoint

gin-boilerplate/tests/article_test.go

Lines 377 to 398 in 19bc753

 /** 

 * TestCreateArticleUnauthorized 

 * Test getting the article with unauthorized user (wrong or expired access_token) 

 * 

 * Must return response code 401 

  */ 

 func TestCreateArticleUnauthorized(t *testing.T) { 

 testRouter := SetupRouter() 

 req, err := http.NewRequest("GET", fmt.Sprintf("/v1/article/%d", articleID), nil) 

 req.Header.Set("Content-Type", "application/json") 

 req.Header.Set("Authorization", fmt.Sprintf("Bearer: %s", "abc123")) 

 if err != nil { 

 fmt.Println(err) 

 } 

 resp := httptest.NewRecorder() 

 testRouter.ServeHTTP(resp, req) 

 assert.Equal(t, resp.Code, http.StatusUnauthorized) 

 }

Add OpenAPI 3.0 support through oapi-codegen for server code generation and documentation support.
Replace go-gorp/gorp and pq with sqlc, pgx and use atlas for DB migrations.
- gorp seems to no longer be maintained as no commits has been made since last year, and pgx is a better maintained alternative than pq these days.

Suggest add go-swagger for documentation

It would be nice to add go-swagger for documentation, do it like this way.
https://medium.com/@pedram.esmaeeli/generate-swagger-specification-from-go-source-code-648615f7b9d9

so it won't be a lot of comment in the code and have a separate docs package from the code.

	/**
	* TestCreateArticleUnauthorized
	* Test getting the article with unauthorized user (wrong or expired access_token)
	*
	* Must return response code 401
	*/
	func TestCreateArticleUnauthorized(t *testing.T) {
	testRouter := SetupRouter()

	req, err := http.NewRequest("GET", fmt.Sprintf("/v1/article/%d", articleID), nil)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", fmt.Sprintf("Bearer: %s", "abc123"))

	if err != nil {
	fmt.Println(err)
	}

	resp := httptest.NewRecorder()
	testRouter.ServeHTTP(resp, req)

	assert.Equal(t, resp.Code, http.StatusUnauthorized)
	}