@agilegravity/backend-client

Sutoga_Backend

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@agilegravity/backend-client
Minified + gzip package size for @agilegravity/backend-client in KB

Readme

backend

Backend - JavaScript client for backend Sutoga Backend This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.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 backend --save
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

Finally, switch to the directory you want to use your backend from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('backend') in javascript files from the directory you ran the last command above from.

git

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

    npm install YOUR_USERNAME/backend --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, that's to say your javascript file where you actually use this library):

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 Backend = require('backend');

var defaultClient = Backend.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['authorization'] = "Token"

var api = new Backend.BricksApi()

var topicId = "topicId_example"; // {String} topic id

var opts = { 
  'body': new Backend.Brick() // {Brick} 
};
api.createBrick(topicId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

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

Class Method HTTP request Description
Backend.BricksApi createBrick POST /topics/{topicId}/brick create a brick
Backend.TopicApi addMicroIntends POST /topics/{topicId}/ai-context/microintends add a array of MicroIntends to the aicontext of a topic
Backend.TopicApi addTags POST /topics/{topicId}/tags add a array of tags to a topic
Backend.TopicApi createTopic POST /topics create a topic
Backend.TopicApi getAiContext GET /topics/{topicId}/ai-context get AiContext for a topic
Backend.TopicApi getMyTopics GET /me/topics/ get the topics of a user
Backend.TopicApi getTopic GET /topics/{topicId} get the topic
Backend.TopicApi removeTags DELETE /topics/{topicId}/tags remove a tags from a topic
Backend.UserApi loginCreatePost POST /loginCreate
Backend.UserApi passportLoginPost POST /passport/login

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.