apileague-js

v1.9.0

Published

a month ago

API League is a Hub for World Class APIs.

0High
0Medium
0Low

apileague-js

ApileagueJs - JavaScript client for apileague-js API League is a Hub for World Class APIs. This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.9.0
Package version: 1.9.0
Generator version: 7.8.0-SNAPSHOT
Build package: org.openapitools.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 apileague-js --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your apileague-js from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/ddsky/api-league-clients/tree/master/javascript/ then install it via:

    npm install ddsky/api-league-clients/tree/master/javascript/ --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 ApileagueJs = require('apileague-js');

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

var api = new ApileagueJs.ArtApi()
var opts = {
  'query': "landscape paintings", // {String} The search query.
  'earliestStartDate': 1750, // {Number} The artwork must have been created after this date.
  'latestStartDate': 1755, // {Number} The artwork must have been created before this date.
  'earliestEndDate': 1751, // {Number} For artworks with a period of creation, the completion date must be after this date.
  'latestEndDate': 1760, // {Number} For artworks with a period of creation, the completion date must be before this date.
  'minRatio': 0.8, // {Number} The minimum aspect ratio (width/height) the artwork image must have.
  'maxRatio': 1.5, // {Number} The maximum aspect ratio (width/height) the artwork image must have.
  'type': "painting", // {String} The artwork type. Possible values are tapestry, collotype, collage, printmaking, cutting, digital_art, sculpture, metalwork, fragment, token, embroidery, painting, jewellery, print, ornament, photograph, statuette, furniture, needlework, drawing, miniature, tile, stereograph, calligraphy.
  'material': "ivory", // {String} The art material used. Possible values are ferrous_lactate, ink, textile, metal, bronze, canvas, stone, reduced_iron, horn, stoneware, in_shell_walnuts, chalk, velvet, silver, charcoal, gold_leaf, candied_walnuts, porcelain, walnut_halves, jade, cotton, paint, ferrous_fumarate, graphite, cobalt, sandstone, plastic, walnut_pieces, clay, walnuts, cupric_sulfate, ivory, ferric_orthophosphate, earthenware, tin, pen, linen, mahogany, electrolytic_iron, silk, crayon, black_walnuts, brush, beech_wood, terracotta, glass, lead, brass, oil_paint, pencil, leather, gold, marble, watercolor, diamond, iron, ferrous_sulfate, walnut_halves_and_pieces, gouache, wool, ceramic, parchment, cork, limestone, copper_gluconate, paper, pastel, copper, cardboard, plant_material, oak, wood.
  'technique': "etching", // {String} The art technique used. Possible values are engraving, grinding, embroidering, etching, vitrification, gilding, lithography, knitting, cyanotype, silkscreen, woodcut, printing, drypoint, photolithography, weaving, sawing, casting, glassblowing, block_printing, photographing, forging.
  'origin': "Italy", // {String} The country or region of origin for the artwork
  'offset': 0, // {Number} The number of artworks to skip in range [0,1000]
  'number': 10 // {Number} The number of artworks to return in range [1,10]
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.artSearchAPI(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.apileague.com

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ApileagueJs.ArtApi | artSearchAPI | GET /search-artworks | Art Search API ApileagueJs.ArtApi | imageToAsciiArtByURLAPI | GET /convert-image-to-ascii-txt | Image to Ascii Art by URL API ApileagueJs.ArtApi | randomPoemAPI | GET /retrieve-random-poem | Random Poem API ApileagueJs.ArtApi | retrieveArtworkById | GET /retrieve-artwork | Retrieve Artwork by Id ApileagueJs.BooksApi | findSimilarBooksAPI | GET /list-similar-books | Find Similar Books API ApileagueJs.BooksApi | searchBooksAPI | GET /search-books | Search Books API ApileagueJs.FoodApi | computeNutritionAPI | GET /compute-nutrition | Compute Nutrition API ApileagueJs.FoodApi | retrieveRecipeInformationAPI | GET /retrieve-recipe | Retrieve Recipe Information API ApileagueJs.FoodApi | searchDrinksAPI | GET /search-drinks | Search Drinks API ApileagueJs.FoodApi | searchRecipesAPI | GET /search-recipes | Search Recipes API ApileagueJs.GamesApi | findSimilarGamesAPI | GET /list-similar-games | Find Similar Games API ApileagueJs.GamesApi | retrieveGameById | GET /retrieve-game | Retrieve Game by Id ApileagueJs.GamesApi | searchGamesAPI | GET /search-games | Search Games API ApileagueJs.HumorApi | generateNonsenseWordAPI | GET /generate-nonsense-word | Generate Nonsense Word API ApileagueJs.HumorApi | randomJokeAPI | GET /retrieve-random-joke | Random Joke API ApileagueJs.HumorApi | randomMemeAPI | GET /retrieve-random-meme | Random Meme API ApileagueJs.HumorApi | searchGifsAPI | GET /search-gifs | Search Gifs API ApileagueJs.HumorApi | searchJokesAPI | GET /search-jokes | Search Jokes API ApileagueJs.HumorApi | searchMemesAPI | GET /search-memes | Search Memes API ApileagueJs.KnowledgeApi | randomAffirmationAPI | GET /retrieve-random-affirmation | Random Affirmation API ApileagueJs.KnowledgeApi | randomLifeHackAPI | GET /retrieve-random-life-hack | Random Life Hack API ApileagueJs.KnowledgeApi | randomQuoteAPI | GET /retrieve-random-quote | Random Quote API ApileagueJs.KnowledgeApi | randomRiddleAPI | GET /retrieve-random-riddle | Random Riddle API ApileagueJs.KnowledgeApi | randomTriviaAPI | GET /retrieve-random-trivia | Random Trivia API ApileagueJs.MathApi | convertUnitsAPI | GET /convert-units | Convert Units API ApileagueJs.MediaApi | detectMainImageColorAPI | GET /detect-color | Detect Main Image Color API ApileagueJs.MediaApi | rescaleImageAPI | GET /rescale-image | Rescale Image API ApileagueJs.MediaApi | screenshotAPI | GET /take-screenshot | Screenshot API ApileagueJs.MediaApi | searchIconsAPI | GET /search-icons | Search Icons API ApileagueJs.MediaApi | searchRoyaltyFreeImagesAPI | GET /search-images | Search Royalty Free Images API ApileagueJs.MediaApi | vectorSearchAPI | GET /search-vectors | Vector Search API ApileagueJs.NewsApi | extractNewsAPI | GET /extract-news | Extract News API ApileagueJs.NewsApi | searchNewsAPI | GET /search-news | Search News API ApileagueJs.NewsApi | topNewsAPI | GET /retrieve-top-news | Top News API ApileagueJs.StorageApi | readKeyValueFromStoreAPI | GET /read-key-value | Read Key Value from Store API ApileagueJs.StorageApi | storeKeyValueGETAPI | GET /store-key-value | Store Key Value (GET) API ApileagueJs.TextApi | correctSpellingAPI | GET /correct-spelling | Correct Spelling API ApileagueJs.TextApi | detectGenderByNameAPI | GET /detect-gender | Detect Gender by Name API ApileagueJs.TextApi | detectLanguageAPI | GET /detect-language | Detect Language API ApileagueJs.TextApi | detectSentimentAPI | GET /detect-sentiment | Detect Sentiment API ApileagueJs.TextApi | extractDatesAPI | GET /extract-dates | Extract Dates API ApileagueJs.TextApi | extractEntitiesAPI | GET /extract-entities | Extract Entities API ApileagueJs.TextApi | listWordSynonymsAPI | GET /list-synonyms | List Word Synonyms API ApileagueJs.TextApi | pluralizeWordAPI | GET /pluralize-word | Pluralize Word API ApileagueJs.TextApi | scoreReadabilityAPI | GET /score-readability | Score Readability API ApileagueJs.TextApi | scoreTextAPI | GET /score-text | Score Text API ApileagueJs.TextApi | singularizeWordAPI | GET /singularize-word | Singularize Word API ApileagueJs.TextApi | stemTextAPI | GET /stem-text | Stem Text API ApileagueJs.TextApi | tagPartOfSpeechAPI | GET /tag-pos | Tag Part of Speech API ApileagueJs.WebApi | extractAuthorsAPI | GET /extract-authors | Extract Authors API ApileagueJs.WebApi | extractContentFromAWebPageAPI | GET /extract-content | Extract Content from a Web Page API ApileagueJs.WebApi | extractPublishDateAPI | GET /extract-publish-date | Extract Publish Date API ApileagueJs.WebApi | retrievePageRankAPI | GET /retrieve-page-rank | Retrieve Page Rank API ApileagueJs.WebApi | searchWebAPI | GET /search-web | Search Web API ApileagueJs.WebApi | verifyEmailAddressAPI | GET /verify-email | Verify Email Address API

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

apiKey

Type: API key
API key parameter name: api-key
Location: URL query string

headerApiKey

Type: API key
API key parameter name: x-api-key
Location: HTTP header

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

apileague-js

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

apiKey

headerApiKey