Lms-api-client NPM

my_api

MyApi - JavaScript client for my_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: v1
Package version: v1
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 my_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 my_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 MyApi = require('my_api');


var api = new MyApi.AuthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiAuthLoginGet(callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request
MyApi.AuthApi	apiAuthLoginGet	GET /api/Auth/login
MyApi.AuthApi	apiAuthLogoutGet	GET /api/Auth/logout
MyApi.DisciplineApi	apiDisciplineGet	GET /api/Discipline
MyApi.StudyGroupApi	apiStudyGroupMyGet	GET /api/StudyGroup/My
MyApi.StudyGroupApi	apiStudyGroupOwnerGet	GET /api/StudyGroup/Owner
MyApi.StudyGroupApi	apiStudyGroupPost	POST /api/StudyGroup
MyApi.StudyGroupApi	apiStudyGroupStudyGroupIdActivatePost	POST /api/StudyGroup/{studyGroupId}/Activate
MyApi.StudyGroupApi	apiStudyGroupStudyGroupIdDelete	DELETE /api/StudyGroup/{studyGroupId}
MyApi.StudyGroupApi	apiStudyGroupStudyGroupIdGet	GET /api/StudyGroup/{studyGroupId}
MyApi.StudyGroupApi	apiStudyGroupStudyGroupIdParticipantPost	POST /api/StudyGroup/{studyGroupId}/Participant
MyApi.StudyGroupApi	apiStudyGroupStudyGroupIdParticipantUserIdDelete	DELETE /api/StudyGroup/{studyGroupId}/Participant/{userId}
MyApi.StudyGroupApi	apiStudyGroupStudyGroupIdParticipantsGet	GET /api/StudyGroup/{studyGroupId}/Participants
MyApi.StudyGroupApi	apiStudyGroupStudyGroupIdPut	PUT /api/StudyGroup/{studyGroupId}
MyApi.UserApi	apiUserSchoolSchoolIdClassClassIdOrdinalUsersGet	GET /api/User/School/{schoolId}/Class/{classId}/{ordinal}/Users
MyApi.UserApi	apiUserSchoolSchoolIdClassesGet	GET /api/User/School/{schoolId}/Classes
MyApi.UserApi	apiUserSchoolsGet	GET /api/User/Schools
MyApi.UserApi	apiUserUserIdGet	GET /api/User/{userId}
MyApi.UserApi	apiUserUserIdPut	PUT /api/User/{userId}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

@babel/cli superagent

@everything-registry/sub-chunk-2090 @zalastax/nolb-lm @infinitebrahmanuniverse/nolb-lm

1.0.1

2 years ago

1.0.0

2 years ago