1.0.0 • Published 3 years ago

cocktail-db-api v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
3 years ago

cocktail_db_api

CocktailDbApi - JavaScript client for cocktail_db_api Swagger generated especs for the cocktails db Open API This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.1
  • Package version: 0.1
  • Build package: io.swagger.codegen.v3.generators.javascript.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 cocktail_db_api --save

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):

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 CocktailDbApi = require('cocktail_db_api');

var api = new CocktailDbApi.DefaultApi()
var opts = { 
  'c': "c_example" // {String} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.filterPhpGet(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://www.thecocktaildb.com/api/json/v1/1

ClassMethodHTTP requestDescription
CocktailDbApi.DefaultApifilterPhpGetGET /filter.php
CocktailDbApi.DefaultApilookupPhpGetGET /lookup.php
CocktailDbApi.DefaultApirandomPhpGetGET /random.php
CocktailDbApi.DefaultApisearchPhpGetGET /search.php

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

1.0.0

3 years ago