m_tutor_thirdparty_api v1.0.0
m_tutor_thirdparty_api
MTutorThirdpartyApi - JavaScript client for m_tutor_thirdparty_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: 1.0.0
- Package version: 1.0.0
- 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 m_tutor_thirdparty_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 m_tutor_thirdparty_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('m_tutor_thirdparty_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/m_tutor_thirdparty_api then install it via:
npm install YOUR_USERNAME/m_tutor_thirdparty_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 MTutorThirdpartyApi = require('m_tutor_thirdparty_api');
var api = new MTutorThirdpartyApi.EchoApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.apiEchoServertimeGet(callback);
Documentation for API Endpoints
All URIs are relative to https://service-staging.mtutor.engkoo.com
Class | Method | HTTP request | Description |
---|---|---|---|
MTutorThirdpartyApi.EchoApi | apiEchoServertimeGet | GET /api/echo/Servertime | |
MTutorThirdpartyApi.OauthApi | oauthLoginPost | POST /oauth/login | |
MTutorThirdpartyApi.PronunciationRaterApi | getPrResult | GET /api/PronunicationRater | |
MTutorThirdpartyApi.PronunciationRaterApi | pronunciationRater | POST /api/PronunicationRater |
Documentation for Models
- MTutorThirdpartyApi.AccessTokenResp
- MTutorThirdpartyApi.JobDesc
- MTutorThirdpartyApi.PrResult
- MTutorThirdpartyApi.PrResultDetail
- MTutorThirdpartyApi.PrResultDetailPhonDetails
- MTutorThirdpartyApi.PrResultDetailSyllDetails
- MTutorThirdpartyApi.PrResultDetailWordDetails
- MTutorThirdpartyApi.ServerTime
- MTutorThirdpartyApi.ServerTimeData
Documentation for Authorization
Bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
7 years ago