Skip to content

oeeckhoutte/stack

 
 

Repository files navigation

Stack GoDoc

Stack is a lightweight not-a-framework RESTful API that allow you to easily get started with your next project and show some of the my best practices about building RESTful APIs in Go.

What is included?

  • Proper using of middlewares
  • Learn how to organize your files & folders structure
  • User & Token APIs out of the box
  • Authentication via tokens
  • Keep context by *http.Request with gorilla/context
  • Form parsing with gorilla/schema & validation with go-playground/validator
  • MongoDB with go-mgo/mgo
  • Command-line configuration
  • App versioning over latest git commit hash
  • ...

Usage

Run

make run

Run via Docker Compose

docker-compose up

Stop

^C ctrl+c

Hard Stop

^C^C twice

Out of The Box Endpoints

  • post /users
  • get /users
  • get /users/{id}
  • get /me
  • post /tokens
  • delete /tokens
  • delete /tokens/{token}
  • get /version

Authentication

Send your access_token over X-Auth-Token header

For more information read the source code and do requests on endpoints

Best practices resources about building APIs

Contribute

  • Share your ideas by opening new issues
  • Feel free to ask for feature requests

About

Go RESTful API Stack w/ MongoDB

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 98.3%
  • Makefile 1.7%