beer-api-client

BeerApiClient - JavaScript client for beer-api-client API spec for Beer API. This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.1
• Package version: 0.0.10
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install beer-api-client --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your beer-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('beer-api-client') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var BeerApiClient = require('beer-api-client');

var defaultClient = BeerApiClient.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new BeerApiClient.BarBeersApi()

var barId = "barId_example"; // {String} Id of the bar

var payload = new BeerApiClient.Beer(); // {Beer} Payload

api.createBeer(barId, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://localhost/rest/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- BeerApiClient.BarBeersApi | createBeer | POST /bars/{barId}/beers/ | Create beer BeerApiClient.BarBeersApi | deleteBeer | DELETE /bars/{barId}/beers/{beerId} | Delete beer BeerApiClient.BarBeersApi | findBeer | GET /bars/{barId}/beers/{beerId} | Find beer BeerApiClient.BarBeersApi | listBeers | GET /bars/{barId}/beers/ | List beers BeerApiClient.BarBeersApi | updateBeer | PUT /bars/{barId}/beers/{beerId} | Update beer BeerApiClient.BeerFlavorsApi | listBeerFlavors | GET /beerFlavors | List beer flavors BeerApiClient.SearchApi | searchBeers | GET /bars/{barId}/searchBeers | Search beers BeerApiClient.SystemApi | systemPing | GET /system/ping | Ping

Documentation for Models

• BeerApiClient.BadRequest
• BeerApiClient.Beer
• BeerApiClient.BeerExternalServices
• BeerApiClient.BeerFlavor
• BeerApiClient.BeerImage
• BeerApiClient.BeerListSort
• BeerApiClient.BeerRating
• BeerApiClient.Forbidden
• BeerApiClient.InternalServerError
• BeerApiClient.NotFound
• BeerApiClient.NotImplemented

Documentation for Authorization

bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header