Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

apileague-js

Package Overview
Dependencies
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

apileague-js

API League is a Hub for World Class APIs.

  • 1.0.0
  • npm
  • Socket score

Version published
Weekly downloads
0
Maintainers
1
Weekly downloads
 
Created
Source

api_league

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

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.5.0
  • 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 api_league --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 api_league 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 ApiLeague = require('api_league');

var defaultClient = ApiLeague.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 ApiLeague.ArtApi()
var url = "https://upload.wikimedia.org/wikipedia/commons/3/35/Basic_human_drawing.png"; // {String} The URL to the image.
var opts = {
  'width': 200, // {Number} The maximum width of the image (default 400, max. 500).
  'height': 200 // {Number} The maximum height of the image (default 400, max. 500).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.imageToAsciiArtByURL(url, opts, callback);

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
ApiLeague.ArtApiimageToAsciiArtByURLGET /convert-image-to-ascii-txtImage to Ascii Art by URL
ApiLeague.ArtApirandomPoemGET /retrieve-random-poemRandom Poem
ApiLeague.BooksApifindSimilarBooksGET /list-similar-booksFind Similar Books
ApiLeague.BooksApisearchBooksGET /search-booksSearch Books
ApiLeague.FoodApicomputeNutritionGET /compute-nutritionCompute Nutrition
ApiLeague.FoodApiretrieveRecipeInformationGET /retrieve-recipeRetrieve Recipe Information
ApiLeague.FoodApisearchRecipesGET /search-recipesSearch Recipes
ApiLeague.FoodApisearchRestaurantsGET /search-restaurantsSearch Restaurants
ApiLeague.HumorApigenerateNonsenseWordGET /generate-nonsense-wordGenerate Nonsense Word
ApiLeague.HumorApirandomJokeGET /retrieve-random-jokeRandom Joke
ApiLeague.HumorApirandomMemeGET /retrieve-random-memeRandom Meme
ApiLeague.HumorApisearchGifsGET /search-gifsSearch Gifs
ApiLeague.HumorApisearchJokesGET /search-jokesSearch Jokes
ApiLeague.HumorApisearchMemesGET /search-memesSearch Memes
ApiLeague.KnowledgeApirandomQuoteGET /retrieve-random-quoteRandom Quote
ApiLeague.KnowledgeApirandomTriviaGET /retrieve-random-triviaRandom Trivia
ApiLeague.MathApiconvertUnitsGET /convert-unitsConvert Units
ApiLeague.MediaApidetectMainImageColorGET /detect-colorDetect Main Image Color
ApiLeague.MediaApirescaleImageGET /rescale-imageRescale Image
ApiLeague.MediaApisearchRoyaltyFreeImagesGET /search-imagesSearch Royalty Free Images
ApiLeague.NewsApiextractNewsGET /extract-newsExtract News
ApiLeague.NewsApisearchNewsGET /search-newsSearch News
ApiLeague.StorageApireadKeyValueFromStoreGET /read-key-valueRead Key Value from Store
ApiLeague.StorageApistoreKeyValueGETGET /store-key-valueStore Key Value (GET)
ApiLeague.TextApicorrectSpellingGET /correct-spellingCorrect Spelling
ApiLeague.TextApidetectLanguageGET /detect-languageDetect Language
ApiLeague.TextApidetectSentimentGET /detect-sentimentDetect Sentiment
ApiLeague.TextApiextractDatesGET /extract-datesExtract Dates
ApiLeague.TextApiextractEntitiesGET /extract-entitiesExtract Entities
ApiLeague.TextApilistWordSynonymsGET /list-synonymsList Word Synonyms
ApiLeague.TextApipartOfSpeechTaggingGET /tag-posPart of Speech Tagging
ApiLeague.TextApipluralizeWordGET /pluralize-wordPluralize Word
ApiLeague.TextApiscoreReadabilityGET /score-readabilityScore Readability
ApiLeague.TextApiscoreTextGET /score-textScore Text
ApiLeague.TextApisingularizeWordGET /singularize-wordSingularize Word
ApiLeague.TextApitextStemmingGET /stem-textText Stemming
ApiLeague.WebApiextractAuthorsGET /extract-authorsExtract Authors
ApiLeague.WebApiextractContentFromAWebPageGET /extract-contentExtract Content from a Web Page
ApiLeague.WebApiextractPublishDateGET /extract-publish-dateExtract Publish Date
ApiLeague.WebApisearchWebGET /search-webSearch Web

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

FAQs

Package last updated on 21 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc