apileague-js
Advanced tools
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:
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
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
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
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.
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
}
}
]
}
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 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);
All URIs are relative to https://api.apileague.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ApileagueJs.ArtApi | imageToAsciiArtByURL | GET /convert-image-to-ascii-txt | Image to Ascii Art by URL |
| ApileagueJs.ArtApi | randomPoem | GET /retrieve-random-poem | Random Poem |
| ApileagueJs.BooksApi | findSimilarBooks | GET /list-similar-books | Find Similar Books |
| ApileagueJs.BooksApi | searchBooks | GET /search-books | Search Books |
| ApileagueJs.FoodApi | computeNutrition | GET /compute-nutrition | Compute Nutrition |
| ApileagueJs.FoodApi | retrieveRecipeInformation | GET /retrieve-recipe | Retrieve Recipe Information |
| ApileagueJs.FoodApi | searchDrinks | GET /search-drinks | Search Drinks |
| ApileagueJs.FoodApi | searchRecipes | GET /search-recipes | Search Recipes |
| ApileagueJs.FoodApi | searchRestaurants | GET /search-restaurants | Search Restaurants |
| ApileagueJs.HumorApi | generateNonsenseWord | GET /generate-nonsense-word | Generate Nonsense Word |
| ApileagueJs.HumorApi | randomJoke | GET /retrieve-random-joke | Random Joke |
| ApileagueJs.HumorApi | randomMeme | GET /retrieve-random-meme | Random Meme |
| ApileagueJs.HumorApi | searchGifs | GET /search-gifs | Search Gifs |
| ApileagueJs.HumorApi | searchJokes | GET /search-jokes | Search Jokes |
| ApileagueJs.HumorApi | searchMemes | GET /search-memes | Search Memes |
| ApileagueJs.KnowledgeApi | randomQuote | GET /retrieve-random-quote | Random Quote |
| ApileagueJs.KnowledgeApi | randomRiddle | GET /retrieve-random-riddle | Random Riddle |
| ApileagueJs.KnowledgeApi | randomTrivia | GET /retrieve-random-trivia | Random Trivia |
| ApileagueJs.MathApi | convertUnits | GET /convert-units | Convert Units |
| ApileagueJs.MediaApi | detectMainImageColor | GET /detect-color | Detect Main Image Color |
| ApileagueJs.MediaApi | rescaleImage | GET /rescale-image | Rescale Image |
| ApileagueJs.MediaApi | searchIcons | GET /search-icons | Search Icons |
| ApileagueJs.MediaApi | searchRoyaltyFreeImages | GET /search-images | Search Royalty Free Images |
| ApileagueJs.NewsApi | extractNews | GET /extract-news | Extract News |
| ApileagueJs.NewsApi | searchNews | GET /search-news | Search News |
| ApileagueJs.NewsApi | topNews | GET /retrieve-top-news | Top News |
| ApileagueJs.StorageApi | readKeyValueFromStore | GET /read-key-value | Read Key Value from Store |
| ApileagueJs.StorageApi | storeKeyValueGET | GET /store-key-value | Store Key Value (GET) |
| ApileagueJs.TextApi | correctSpelling | GET /correct-spelling | Correct Spelling |
| ApileagueJs.TextApi | detectGenderByName | GET /detect-gender | Detect Gender by Name |
| ApileagueJs.TextApi | detectLanguage | GET /detect-language | Detect Language |
| ApileagueJs.TextApi | detectSentiment | GET /detect-sentiment | Detect Sentiment |
| ApileagueJs.TextApi | extractDates | GET /extract-dates | Extract Dates |
| ApileagueJs.TextApi | extractEntities | GET /extract-entities | Extract Entities |
| ApileagueJs.TextApi | listWordSynonyms | GET /list-synonyms | List Word Synonyms |
| ApileagueJs.TextApi | pluralizeWord | GET /pluralize-word | Pluralize Word |
| ApileagueJs.TextApi | scoreReadability | GET /score-readability | Score Readability |
| ApileagueJs.TextApi | scoreText | GET /score-text | Score Text |
| ApileagueJs.TextApi | singularizeWord | GET /singularize-word | Singularize Word |
| ApileagueJs.TextApi | stemText | GET /stem-text | Stem Text |
| ApileagueJs.TextApi | tagPartOfSpeech | GET /tag-pos | Tag Part of Speech |
| ApileagueJs.WebApi | extractAuthors | GET /extract-authors | Extract Authors |
| ApileagueJs.WebApi | extractContentFromAWebPage | GET /extract-content | Extract Content from a Web Page |
| ApileagueJs.WebApi | extractPublishDate | GET /extract-publish-date | Extract Publish Date |
| ApileagueJs.WebApi | retrievePageRank | GET /retrieve-page-rank | Retrieve Page Rank |
| ApileagueJs.WebApi | searchWeb | GET /search-web | Search Web |
| ApileagueJs.WebApi | verifyEmailAddress | GET /verify-email | Verify Email Address |
Authentication schemes defined for the API:
FAQs
API League is a Hub for World Class APIs.
The npm package apileague-js receives a total of 24 weekly downloads. As such, apileague-js popularity was classified as not popular.
We found that apileague-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
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.
Security News
Elastic’s return to open source with the AGPL license has been met with skepticism, as many developers see it as a strategic move rather than a genuine effort to restore user trust and freedoms.
Security News
A new "revival hijack" supply chain attack targets deleted Python packages, with an estimated 22K packages at risk. Socket can detect and block hijacked packages that have added malicious code.
Product
We're introducing a new Analytics feature in the Socket dashboard so you can view changes in your organization's and repositories' alerts over time.