@jpwaves/humor_api v1.0.0

humor_api

HumorApi - JavaScript client for humor_api Awesome Humor API. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://humorapi.com

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 humor_api --save

Finaly, 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 humor_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finaly, you need to build the module:

npm run build

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 HumorApi = require('humor_api');

var defaultClient = HumorApi.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"

var api = new HumorApi.JokesApi()
var opts = {
  'body': "body_example" // {String} Post the joke as plain text.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.analyzeJoke(opts, callback);

Documentation for API Endpoints

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

Documentation for Models

• HumorApi.InlineResponse200
• HumorApi.InlineResponse2001
• HumorApi.InlineResponse2002
• HumorApi.InlineResponse2003
• HumorApi.InlineResponse2004
• HumorApi.InlineResponse2005
• HumorApi.InlineResponse2006
• HumorApi.InlineResponse2007
• HumorApi.InlineResponse2008
• HumorApi.InlineResponse2009

Documentation for Authorization

apiKey

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