quillionz_api_free
v1.0.0
Published
JS API client generated by OpenAPI Generator
Downloads
2
Readme
quillionz_api_free
QuillionzApiFree - JavaScript client for quillionz_api_free No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.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 quillionz_api_free --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 quillionz_api_free 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 QuillionzApiFree = require('quillionz_api_free');
var defaultClient = QuillionzApiFree.ApiClient.instance;
// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"
var api = new QuillionzApiFree.DefaultApi()
var shortAnswer = true; // {Boolean}
var recall = true; // {Boolean}
var mcq = true; // {Boolean}
var whQuestions = true; // {Boolean}
var title = "title_example"; // {String}
var body = null; // {Object} Content length should be between 300 to 3000 words
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.aPISubmitContentGetQuestionsPost(shortAnswer, recall, mcq, whQuestions, title, body, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- QuillionzApiFree.DefaultApi | aPISubmitContentGetQuestionsPost | POST /API/SubmitContent_GetQuestions |
Documentation for Models
Documentation for Authorization
default
- Type: OAuth
- Flow: implicit
- Authorization URL: https://test.com
- Scopes: N/A