Coder Social home page Coder Social logo

byob's Introduction

🍻🍺🍻🍺🍻🍺🍻🍺🍻🍻🍺🍻🍺🍻🍺🍻🍺🍻

Colorado Brews API

About the API 🍻

BYOB is an API that provides data about breweries in Denver and the beers that they carry. Users can add data to the API through POST requests, delete data with DELETE requests, and edit data with PUT requests.

See the deployed app here

Installation Instructions

How to Contribute

/api/breweries

GET

Making an API call to this endpoint returns all breweries.

Data returned for each brewery includes:

  • brewery id
  • brewery name
  • brewery city
  • whether or not the brewery serves food
  • whether or not the brewery is dog friendly
  • whether or not the brewery has outdoor seating
  • brewery website
  • creation timestamp
  • update timestamp
Example of returned JSON:
[{
    "id": 1,
    "name": "Odell",
    "city": "Fort Collins",
    "food": "no",
    "dog_friendly": "yes",
    "outdoor_seating": "yes",
    "website": "www.odell.com",
    "created_at": "2018-12-06T18:40:50.931Z",
    "updated_at": "2018-12-06T18:40:50.931Z"
  },
  {
    "id": 2,
    "name": "New Belgium",
    "city": "Fort Collins",
    "food": "yes",
    "dog_friendly": "no",
    "outdoor_seating": "no",
    "website": "www.newbelgium.com",
    "created_at": "2018-12-06T18:40:50.931Z",
    "updated_at": "2018-12-06T18:40:50.931Z"
  },
  {
    "id": 3,
    "name": "Avery Brewing",
    "city": "Denver",
    "food": "yes",
    "dog_friendly": "yes",
    "outdoor_seating": "yes",
    "website": "www.averybrewing.com",
    "created_at": "2018-12-06T18:40:50.931Z",
    "updated_at": "2018-12-06T18:40:50.931Z"
  }]

Querying database

Including the brewery city in the URL will return all breweries located in that city.

Example query:
http://..../api/breweries/?city=Denver
Example of returned JSON:
[{
  "id": 22,
   "name": "10 Barrel Brewing Company",
   "city": "Denver",
   "food": "yes",
   "dog_friendly": "no",
   "outdoor_seating": "yes",
   "website": "www.10barrel.com",
   "created_at": "2019-01-29T17:08:02.602Z",
   "updated_at": "2019-01-29T17:08:02.602Z"
},
{
  "id": 32,
  "name": "Black Project Spontaneous & Wild Ales",
  "city": "Denver",
  "food": "no",
  "dog_friendly": "no",
  "outdoor_seating": "no",
  "website": "www.blackprojectbeer.com",
  "created_at": "2019-01-29T17:08:02.612Z",
  "updated_at": "2019-01-29T17:08:02.612Z"
 }]

/api/breweries/:id

GET

Making an API call to this endpoint returns a brewery with the specified id.

  • brewery id
  • brewery name
  • brewery city
  • whether or not the brewery serves food
  • whether or not the brewery is dog friendly
  • whether or not the brewery has outdoor seating
  • brewery website
  • creation timestamp
  • update timestamp
Required:

An id that corresponds to a brewery present in the database must be provided in the URL to return the desired JSON.

URL with specified id:

http://..../api/breweries/29
Example of returned JSON:
{
  "id": 29,
   "name": "Odell Brewing Company",
   "city": "Denver",
   "food": "yes",
   "dog_friendly": "yes",
   "outdoor_seating": "yes",
   "website": "www.odellbrewing.com",
   "created_at": "2019-01-29T17:08:02.608Z",
   "updated_at": "2019-01-29T17:08:02.608Z"
 }

/api/breweries/:id/beers

GET

Making an API call to this endpoint returns all beers for the brewery with the specified id.

Data returned for each beer:

  • beer id
  • beer name
  • beer style
  • beer abv
  • beer availability
  • corresponding brewery id
  • creation timestamp
  • update timestamp
Required:

An id that corresponds to an beer present in the database must be provided in the URL to return the desired JSON.

URL with specified id:

http://..../api/breweries/1/beers

Corresponding brewery:

{
  "id": 29,
   "name": "Odell Brewing Company",
   "city": "Denver",
   "food": "yes",
   "dog_friendly": "yes",
   "outdoor_seating": "yes",
   "website": "www.odellbrewing.com",
   "created_at": "2019-01-29T17:08:02.608Z",
   "updated_at": "2019-01-29T17:08:02.608Z"
 }
Example of returned JSON:
[{
   "id": 19,
   "name": "Gramps",
   "style": "Oatmeal Stout",
   "abv": "6.4",
   "availability": "Special Release",
   "brewery_id": 29,
   "created_at": "2019-01-29T17:08:02.625Z",
   "updated_at": "2019-01-29T17:08:02.625Z"
  },
{
  "id": 20,
  "name": "Odell IPA",
  "style": "American IPA",
  "abv": "7.0",
  "availability": "Year-Round",
  "brewery_id": 29,
  "created_at": "2019-01-29T17:08:02.625Z",
  "updated_at": "2019-01-29T17:08:02.625Z"
}]

/api/breweries

POST

Making an API call to this endpoint adds a brewery to the database.

Required:

A correctly formatted brewery object must be provided in the request body in order to post to the database.

Example of correctly formatted brewery object:
{ name: <STRING>, city: <STRING>, food: <STRING>, dog_friendly: <STRING>, outdoor_seating: <STRING>, website: <STRING>  }

{
  "name": "Vail Brewing Company",
  "city": "Vail",
  "food": "yes",
  "dog_friendly": "yes",
  "outdoor_seating": "no",
  "website": "www.vailbrewingco.com/", 
}

/api/breweries/:id

PUT

Making an API call to this endpoint updates brewery properties of the brewery with the specified id.

Required:

An id that corresponds to a brewery present in the database must be provided in the URL.

URL with specified id:

http://..../api/breweries/1

/api/breweries/:id

DELETE

Making an API call to this endpoint deletes the brewery with the specified id.

Required:

An id that corresponds to a brewery present in the database must be provided in the URL.

URL with specified id:

http://..../api/breweries/1

/api/beers

GET

Making an API call to this endpoint returns all beers.

Data returned for each beer:

  • beer id
  • beer name
  • beer style
  • beer abv
  • beer availability
  • corresponding brewery id
  • creation timestamp
  • update timestamp
Example of returned JSON:
[{
    "id": 14,
    "name": "Wanda Mae's Peach Pie",
    "style": "American Brown Ale",
    "abv": "5.0",
    "availability": "Rotating",
    "brewery_id": 26,
    "created_at": "2019-01-29T17:08:02.623Z",
    "updated_at": "2019-01-29T17:08:02.623Z"
  },
  {
    "id": 19,
    "name": "Gramps",
    "style": "Oatmeal Stout",
    "abv": "6.4",
    "availability": "Special Release",
    "brewery_id": 29,
    "created_at": "2019-01-29T17:08:02.625Z",
    "updated_at": "2019-01-29T17:08:02.625Z"
  },
  {
    "id": 24,
    "name": "Tripel",
    "style": "Belgian Tripel",
    "abv": "7.8",
    "availability": "Year-Round",
    "brewery_id": 30,
    "created_at": "2019-01-29T17:08:02.628Z",
    "updated_at": "2019-01-29T17:08:02.628Z"
  }]

/api/beers/:id

GET

Making an API call to this endpoint returns a beer with the specified id

Data returned the beer includes:

  • beer id
  • beer name
  • beer style
  • beer abv
  • beer availability
  • corresponding brewery id
  • creation timestamp
  • update timestamp
Required:

An id that corresponds to a beer present in the database must be provided in the URL to return the desired JSON.

URL with specified id:

http://..../api/beers/14
Example of returned JSON:
{ 
  "id": 14,
  "name": "Wanda Mae's Peach Pie",
  "style": "American Brown Ale",
  "abv": "5.0",
  "availability": "Rotating",
  "brewery_id": 26,
  "created_at": "2019-01-29T17:08:02.623Z",
  "updated_at": "2019-01-29T17:08:02.623Z"
}

/api/beers

POST

Making an API call to this endpoint adds a beer to the database

Required:
  • A correctly formatted beer object must be provided in the request body in order to post to the database.
Example of correctly formatted beer object:
{ name: <STRING>, style: <STRING>, abv: <STRING>, availability: <STRING> }

{
  "name": "Tripel",
  "style": "Belgian Tripel",
  "abv": "7.8",
  "availability": "Year-Round"
}

/api/beers/:id

PUT

Making an API call to this endpoint updates beer properties of the beer with the specified id.

Required:

An id that corresponds to a beer present in the database must be provided in the URL.

URL with specified id:

http://..../api/beers/1

/api/beers/:id

DELETE

Making an API call to this endpoint deletes the beer with the specified id.

Required:

An id that corresponds to a beer present in the database must be provided in the URL.

URL with specified id:

http://..../api/beers/1

Contributors

Loryn Mason GITHUB: @lorynmason

Ashley Levi GITHUB: @ashleylevi

🍻🍺🍻🍺🍻🍺🍻🍺🍻🍻🍺🍻🍺🍻🍺🍻🍺🍻

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.