0.0.0 • Published 7 years ago

quizzer_rest_api v0.0.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
7 years ago

quizzer_rest_api

QuizzerRestApi - JavaScript client for quizzer_rest_api API for quizzer REST Server This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.0.0
  • Package version: 0.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 quizzer_rest_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/quizzer_rest_api then install it via:

    npm install YOUR_USERNAME/quizzer_rest_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):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var QuizzerRestApi = require('quizzer_rest_api');

var api = new QuizzerRestApi.AdminApi()

var opts = { 
  'body': new QuizzerRestApi.MakeUserAdminReq() // {MakeUserAdminReq} request.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.makeUserAdminPOST(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:4000/

ClassMethodHTTP requestDescription
QuizzerRestApi.AdminApimakeUserAdminPOSTPOST /makeUserAdminmake a user admin
QuizzerRestApi.AdminApiusersGETGET /getUserslist users
QuizzerRestApi.PublicApileaderBoardGETGET /getLeaderBoardget the leaderboard
QuizzerRestApi.PublicApirootGETGET /nothing
QuizzerRestApi.PublicApiuserExistsGETGET /getUserExistscheck username
QuizzerRestApi.UserApianswerQuestionPOSTPOST /answerQuestionanswer a Question
QuizzerRestApi.UserApigetMyScoresGETGET /getMyScoresget user scores
QuizzerRestApi.UserApigetPicGETGET /getPicget list of quizzes
QuizzerRestApi.UserApigetQuizzesGETGET /getQuizzesget list of quizzes
QuizzerRestApi.UserApiloginPOSTPOST /loginlogin
QuizzerRestApi.UserApiquestionGETGET /getQuestionget a question
QuizzerRestApi.UserApiregisterPOSTPOST /registerregister
QuizzerRestApi.UserApistartQuizPOSTPOST /startQuizstart taking a Quiz

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

0.0.0

7 years ago