quizzer_rest_api v0.0.0
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/
Class | Method | HTTP request | Description |
---|---|---|---|
QuizzerRestApi.AdminApi | makeUserAdminPOST | POST /makeUserAdmin | make a user admin |
QuizzerRestApi.AdminApi | usersGET | GET /getUsers | list users |
QuizzerRestApi.PublicApi | leaderBoardGET | GET /getLeaderBoard | get the leaderboard |
QuizzerRestApi.PublicApi | rootGET | GET / | nothing |
QuizzerRestApi.PublicApi | userExistsGET | GET /getUserExists | check username |
QuizzerRestApi.UserApi | answerQuestionPOST | POST /answerQuestion | answer a Question |
QuizzerRestApi.UserApi | getMyScoresGET | GET /getMyScores | get user scores |
QuizzerRestApi.UserApi | getPicGET | GET /getPic | get list of quizzes |
QuizzerRestApi.UserApi | getQuizzesGET | GET /getQuizzes | get list of quizzes |
QuizzerRestApi.UserApi | loginPOST | POST /login | login |
QuizzerRestApi.UserApi | questionGET | GET /getQuestion | get a question |
QuizzerRestApi.UserApi | registerPOST | POST /register | register |
QuizzerRestApi.UserApi | startQuizPOST | POST /startQuiz | start taking a Quiz |
Documentation for Models
- QuizzerRestApi.AnswerQuestion
- QuizzerRestApi.AnswerQuestionRes
- QuizzerRestApi.Error
- QuizzerRestApi.LeaderBoard
- QuizzerRestApi.LeaderBoardLeaderboard
- QuizzerRestApi.LoginInfo
- QuizzerRestApi.LoginRes
- QuizzerRestApi.MakeUserAdminReq
- QuizzerRestApi.OkRes
- QuizzerRestApi.Question
- QuizzerRestApi.QuestionAnswers
- QuizzerRestApi.QuizBrief
- QuizzerRestApi.QuizzesBrief
- QuizzerRestApi.RegisterInfo
- QuizzerRestApi.StartQuizReq
- QuizzerRestApi.UserScore
- QuizzerRestApi.UserScores
- QuizzerRestApi.UsersInfo
- QuizzerRestApi.UsersInfoUsers
Documentation for Authorization
All endpoints do not require authorization.
7 years ago