fkad_api v0.0.1
fkad_api
FkadApi - JavaScript client for fkad_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: 2018-09-29T02:05:28Z
- Package version: 2018-09-29T02:05:28Z
- Build package: io.swagger.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 fkad_api --save
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
Finally, switch to the directory you want to use your fkad_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('fkad_api')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/fkad_api then install it via:
npm install YOUR_USERNAME/fkad_api --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, that's to say your javascript file where you actually
use this library):
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 FkadApi = require('fkad_api');
var api = new FkadApi.DefaultApi()
var emailID = "emailID_example"; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.fKADFuncAdminapiEmailIDDelete(emailID, callback);
Documentation for API Endpoints
All URIs are relative to https://vul31mqje4.execute-api.us-east-1.amazonaws.com/dev
Class | Method | HTTP request | Description |
---|---|---|---|
FkadApi.DefaultApi | fKADFuncAdminapiEmailIDDelete | DELETE /FKADFunc/adminapi/{email-ID} | |
FkadApi.DefaultApi | fKADFuncAdminapiEmailIDGet | GET /FKADFunc/adminapi/{email-ID} | |
FkadApi.DefaultApi | fKADFuncAdminapiPost | POST /FKADFunc/adminapi | |
FkadApi.DefaultApi | fKADFuncDriverapiEmailIDDelete | DELETE /FKADFunc/driverapi/{email-ID} | |
FkadApi.DefaultApi | fKADFuncDriverapiEmailIDGet | GET /FKADFunc/driverapi/{email-ID} | |
FkadApi.DefaultApi | fKADFuncDriverapiGet | GET /FKADFunc/driverapi | |
FkadApi.DefaultApi | fKADFuncDriverapiPost | POST /FKADFunc/driverapi | |
FkadApi.DefaultApi | fKADFuncOrderapiOrderIDDelete | DELETE /FKADFunc/orderapi/{order-ID} | |
FkadApi.DefaultApi | fKADFuncOrderapiOrderIDGet | GET /FKADFunc/orderapi/{order-ID} | |
FkadApi.DefaultApi | fKADFuncOrderapiPost | POST /FKADFunc/orderapi | |
FkadApi.DefaultApi | fKADFuncUserapiEmailIDDelete | DELETE /FKADFunc/userapi/{email-ID} | |
FkadApi.DefaultApi | fKADFuncUserapiEmailIDGet | GET /FKADFunc/userapi/{email-ID} | |
FkadApi.DefaultApi | fKADFuncUserapiGet | GET /FKADFunc/userapi | |
FkadApi.DefaultApi | fKADFuncUserapiPost | POST /FKADFunc/userapi |
Documentation for Models
Documentation for Authorization
sigv4
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
6 years ago