shario_rest_api v0.0.7
shario_rest_api
SharioRestApi - JavaScript client for shario_rest_api API for share-thread-filter 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 shario_rest_api --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/shario_rest_api then install it via:
npm install YOUR_USERNAME/shario_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 SharioRestApi = require('shario_rest_api');
var api = new SharioRestApi.PublicApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.rootGET(callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:5001/
Class | Method | HTTP request | Description |
---|---|---|---|
SharioRestApi.PublicApi | rootGET | GET / | nothing |
SharioRestApi.UserApi | addKeywordPOST | POST /addKeyword | new keyword |
SharioRestApi.UserApi | filteredThreadByUserGET | GET /getFilteredThreadByUser | get Thread by id, filtered using user keywords |
SharioRestApi.UserApi | loginPOST | POST /login | login |
SharioRestApi.UserApi | threadGET | GET /getThread | get Thread by id |
SharioRestApi.UserApi | threadsBriefGET | GET /getThreadsBrief | get All Threads - brief |
SharioRestApi.UserApi | threadsDateGET | GET /getThreadsAfter | get Threads after a date |
SharioRestApi.UserApi | threadsGET | GET /getThreads | get All Threads |
SharioRestApi.UserApi | userKeywordsGET | GET /userKeywords | get a user's keywords |
SharioRestApi.UserApi | userKeywordsPOST | POST /userKeywords | edit keywords |
Documentation for Models
- SharioRestApi.AddKeywordReq
- SharioRestApi.Error
- SharioRestApi.LoginInfo
- SharioRestApi.LoginRes
- SharioRestApi.OkRes
- SharioRestApi.Post
- SharioRestApi.Thread
- SharioRestApi.Threads
- SharioRestApi.UserKeywordsGETRes
- SharioRestApi.UserKeywordsPOSTReq
Documentation for Authorization
All endpoints do not require authorization.