Giter Club home page Giter Club logo

beer-api's Introduction

Beer API

Getting Started

A poorman's Beer Advocate. See Usage for sample cURL commands below.

Highlights

  • Rails 5 REST API
  • JWT Authentication
  • JSON:API format

Prerequisites

Install Rails API dependencies:

$ bundle install

Setup the development environment:

$ bin/rails db:setup

Run the specs:

$ bin/rspec spec

Installing

Give it a go!

$ bin/rails s

Usage

Get get a JWT

curl -X POST \
  http://localhost:3000/api/v1/auth \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{ "data": { "attributes": { "email":"[email protected]", "password":"password" }} }'

Create a beer

curl -X POST \
  http://localhost:3000/api/v1/beers \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token={{JWT_TOKEN}}' \
  -d '{"data":{ "attributes":{ "name": "Your Awesome Beer!!","style":"Awesome Ale","yeast":"1097 - Fidy Ten","hop":"Blue Dream","malts":"Black malt","ibu":"66 IBU","alcohol":"8.9%","blg":"14.0°Blg"}}}'

Get a list of beers

curl -X GET \
  http://localhost:3000/api/v1/beers \
  -H 'Authorization: Token token={{JWT_TOKEN}}' \
  -H 'Cache-Control: no-cache'

Get data for one beer

curl -X GET \
  http://localhost:3000/api/v1/beers/1 \
  -H 'Authorization: Token token={{JWT_TOKEN}}' \
  -H 'Cache-Control: no-cache'

Built With

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.