Search
K
Beers

SFG Brewery API

1.3OAS 3.0
API Base URL
  • Server 1:http://localhost:8080

    Local Host

  • Server 2:http://api.springframework.guru

    Demo API

Additional Information
Contact John Thompson
GNU GPLv3 License

Beer Service

Brewey Beer Operations

List Beers

List Beers

get

Query Parameters

pageNumberinteger(int32)

Page number.

Default:1

pageSizeinteger(int32)

Page size.

Default:25

beerNamestring

Beer Name

beerStylestring

Beer Style

Allowed values:LAGERPILSNERSTOUTGOSEPORTERALEWHEATIPAPALE_ALESAISON

showInventoryOnHandboolean

Show Inventory On Hand

Default:false

Response

200 application/json

List Beers Response

BeerPagedList

pageableobject
Show Child Parameters
totalPagesinteger(int32)
lastboolean
totalElementsinteger(int32)
sizeinteger(int32)
numberinteger(int32)
numberOfElementsinteger(int32)
sortobject
Show Child Parameters
firstboolean
contentarray | null[object]
Show Child Parameters
get/api/v1/beer
 
200 application/json

Create New Beer

Create New Beer

post

Body

application/json

Beer

beerNamestringrequired
beerStylestringrequired

Allowed values:LAGERPILSNERSTOUTGOSEPORTERALEWHEATIPAPALE_ALESAISON

upcstringrequired
quantityOnHandinteger
pricestring(decimal)required

Response

Create new beer response

post/api/v1/beer

Body

{ "beerName": "beerName", "beerStyle": "LAGER", "upc": "upc", "price": "price" }
 

Get Beer by Id

Get Beer by Id

get

Query Parameters

showInventoryOnHandboolean

Show Inventory On Hand

Default:false

Path Parameters

beerIdstring(uuid)required

Beer Id

Response

application/json

Get Beer by id Response

Beer

idstring | null(uuid)read-only
versioninteger | nullread-only
createdDatestring | null(date-time)read-only
lastModifiedDatestring | null(date-time)read-only
beerNamestringrequired
beerStylestringrequired

Allowed values:LAGERPILSNERSTOUTGOSEPORTERALEWHEATIPAPALE_ALESAISON

upcstringrequired
quantityOnHandinteger
pricestring(decimal)required
get/api/v1/beer/{beerId}
 
application/json