Code Monkey home page Code Monkey logo

go-mux-jwt's Introduction

A simple example of Go (golang) api with jwt authentication

CircleCI Test Coverage Code Climate Issue Count

tech stack

  • Go - a programming language that is fast, uses minimal resources and supports high concurrency
  • Gorilla Mux - minimalistic request router and dispatcher
  • Gorilla Logging Handler - middleware for http request/response logging
  • jwt-go - a jwt library for Go
  • testify - testing and assertion library
  • dep - the official dependency management tool for Go
  • gin (optional) - livereload utility for faster development turnaround in local

pre-requisites

  • Go is installed. To verify, run go version
  • GOPATH is set (e.g. set to ~/go)
  • PATH includes GOPATH/bin
  • dep is installed
    • to get it, run go get -u github.com/golang/dep/cmd/dep

getting started

  • clone repo or download zip
  • get the dependencies by running dep ensure -update in the project directory
  • in the project directory, run go build && ./go-mux-jwt
  • launch the browser and point to the baseurl localhost:3001
    • port can be changed in main.go
  • optional:
    • use gin to monitor for changes and automatically restart the application
      • if you don't have gin, go get github.com/codegangsta/gin
      • in the project directory run gin (no need to build or run executable, when you do this)
    • update Gopkg.toml to use different version(s) for the dependency/vendor libs
      • run dep ensure -update after changing the toml file

running tests

  • to run the tests, run go test in the project directory
  • test coverage:
    • to run tests and generate coverage report, run go test -cover.
    • percentage covered is shown in the terminal upon execution of this command

api and authentication scenarios

  • access the unsecure api GET /metacortex
  • all /api/* calls are secured with JWT authentication
  • try accessing the secure api GET /api/megacity to see an auth error
  • obtain a JWT token here: /static/authenticate.html
    • enter programName:programPassword (neo:keanu)
    • the response contains a JWT token for that program
  • use the token when calling any secure api (/api/*):
    • set the Authorization request header and add the jwt token, like so:
    • Authorization: Bearer \<token\>
  • GET /api/megacity can be accessed with any valid token but GET /api/levrai can only be accessed with neo's token

go-mux-jwt's People

Contributors

pinbar avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.