0.0.7 • Published 7 years ago

shario_rest_api v0.0.7

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

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/

ClassMethodHTTP requestDescription
SharioRestApi.PublicApirootGETGET /nothing
SharioRestApi.UserApiaddKeywordPOSTPOST /addKeywordnew keyword
SharioRestApi.UserApifilteredThreadByUserGETGET /getFilteredThreadByUserget Thread by id, filtered using user keywords
SharioRestApi.UserApiloginPOSTPOST /loginlogin
SharioRestApi.UserApithreadGETGET /getThreadget Thread by id
SharioRestApi.UserApithreadsBriefGETGET /getThreadsBriefget All Threads - brief
SharioRestApi.UserApithreadsDateGETGET /getThreadsAfterget Threads after a date
SharioRestApi.UserApithreadsGETGET /getThreadsget All Threads
SharioRestApi.UserApiuserKeywordsGETGET /userKeywordsget a user's keywords
SharioRestApi.UserApiuserKeywordsPOSTPOST /userKeywordsedit keywords

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

0.0.7

7 years ago

0.0.6

7 years ago

0.0.5

7 years ago

0.0.4

7 years ago

0.0.3

7 years ago

0.0.2

7 years ago

0.0.1

7 years ago

0.0.0

7 years ago