kucukdevapi_js v0.1.0

fast_api

FastApi - JavaScript client for fast_api 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: 0.1.0
• Package version: 0.1.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 fast_api --save

Finally, 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 fast_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, 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 FastApi = require('fast_api');


var api = new FastApi.DefaultApi()
var username = "username_example"; // {String} 
var password = "password_example"; // {String} 
var opts = {
  'grantType': "grantType_example", // {String} 
  'scope': "''", // {String} 
  'clientId': "clientId_example", // {String} 
  'clientSecret': "clientSecret_example" // {String} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loginForAccessTokenTokenPost(username, password, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation for Models

• FastApi.HTTPValidationError
• FastApi.LessonModel
• FastApi.Message
• FastApi.SemesterAPIModel
• FastApi.SemesterModel
• FastApi.Token
• FastApi.UpdateLessonModel
• FastApi.UpdateSemesterModel
• FastApi.UpdateUserModel
• FastApi.UserAPIModel
• FastApi.UserModel
• FastApi.ValidationError

Documentation for Authorization

OAuth2PasswordBearer

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A