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.6.3
- Package version: 1.6.3
- Generator version: 7.8.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
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;
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
var headerApiKey = defaultClient.authentications['headerApiKey'];
headerApiKey.apiKey = "YOUR API KEY"
var api = new ApileagueJs.ArtApi()
var url = "https://upload.wikimedia.org/wikipedia/commons/3/35/Basic_human_drawing.png";
var opts = {
'width': 200,
'height': 200
};
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
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
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header