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

$3

#### npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

``shell
npm install humor_api --save
`

Finaly, you need to build the module:

`shell
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:

`shell
npm install
`

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

`shell
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:

`shell
npm link /path/to/
`

Finaly, you need to build the module:

`shell
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:

`shell
npm install GIT_USER_ID/GIT_REPO_ID --save
`

$3

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):

`shell
browserify main.js > bundle.js
`

Then include bundle.js in the HTML pages.

$3

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:

`javascript
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
`

Getting Started

Please follow the installation instruction and execute the following JS code:

`javascript
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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
HumorApi.JokesApi | analyzeJoke | POST /jokes/analyze | Analyze Joke
HumorApi.JokesApi | downvoteJoke | POST /jokes/{id}/downvote | Downvote a Joke
HumorApi.JokesApi | randomJoke | GET /jokes/random | Random Joke
HumorApi.JokesApi | searchJokes | GET /jokes/search | Search Jokes
HumorApi.JokesApi | submitJoke | POST /jokes | Submit Joke
HumorApi.JokesApi | upvoteJoke | POST /jokes/{id}/upvote | Upvote a Joke
HumorApi.MemesApi | downvoteMeme | POST /memes/{id}/downvote | Downvote a Meme
HumorApi.MemesApi | randomMeme | GET /memes/random | Random Meme
HumorApi.MemesApi | searchMemes | GET /memes/search | Search Memes
HumorApi.MemesApi | upvoteMeme | POST /memes/{id}/upvote | Upvote a Meme
HumorApi.OtherApi | generateNonsenseWord | GET /words/nonsense/random | Generate Nonsense Word
HumorApi.OtherApi | insult | GET /insult | Insult
HumorApi.OtherApi | praise | GET /praise | Praise
HumorApi.OtherApi | rateWord | GET /words/rate | Rate Word
HumorApi.OtherApi | searchGifs | GET /gif/search | Search Gifs

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

$3

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