Skip to content

A simple HttpClient implementation of the BreweryDB API that targets .NET Standard 1.1+

Notifications You must be signed in to change notification settings

cswendrowski/BreweryDbStandard

Repository files navigation

BreweryDbStandard

NuGet

Usage

Create a Client

var breweryDbClient = new BreweryDB("YOUR API KEY");

Basic Search

var result = await breweryDbClient.Search("Nitro Stout");

foreach (var beer in result.Data)
{
    Console.WriteLine(beer.Name);
}

Search with Parameters

var searchParams = new SearchParams()
{
    Type = SearchTypes.BEER,
    WithBreweries = true
};

var result = await breweryDbClient.Search("Nitro Stout", searchParams);

foreach (var beer in result.Data)
{
    Console.WriteLine(beer.Name);
}

A Note on Premium Features

BreweryDB has a collection of premium-only queries and data, documented here. All SearchParams that are premium-only have been annotated [Premium]. This library does nothing with this metadata, but it is useful for your reference.

Roadmap

  • Minimal .NET Standard Version
  • Swap to HttpClient
  • Basic Search Functionality
  • Search Parameters
  • [Premium] Annotation
  • Expand to other API calls

License

MIT License

Copyright (c) 2017 Cody Swendrowski

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A simple HttpClient implementation of the BreweryDB API that targets .NET Standard 1.1+

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages