@labshare/services
LabShare API service manager
Last updated 15 days ago by jamilomar .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @labshare/services 
SYNC missed versions from official npm registry.

Coverage Status Build Status semantic-release codecov

LabShare Services

Usage

npm i @labshare/services

const {Services} = require('@labshare/services');

let options = {
    // Override default options. 
    // The available configuration options are described in the "Configuration" section below.
};

let services = new Services(options);

services.config(({app, services}) => {
   // Optionally perform additional customization of the Express app initialized by Services and the loaded routes
   // Example (adds Express.js compression middleware):
   app.use(compression());
});

// Start up the server with all the loaded HTTP and Socket APIs
services.start();

Configuration

Configuring LabShare Services

Environment Variables

LabShare Service Plugins

Example plugin usage

const {Services} = require('@labshare/services');
const servicesAuth = require('@labshare/services-auth');

const services = new Services({/* options */);

services.config(servicesAuth({/* options */}));

Default HTTP Routes

Versions

GET /<service-path>/versions

Response

{
   "buildVersion":"v2017.0914.5",
   "versions": [
       {"api":"ls", apiDetails":{"name":"labshare","version":"v0.17.0631","description":"LabShare Services"}}
   ]
}

Example: http://localhost:8000/versions

API Explorer

GET /<service-path>/explorer

Response

Swagger HTML page providing documentation for endpoints across all API packages

Example: http://localhost:8000/explorer

Working with LabShare APIs

Running APIs

Running Loopback APIs

Creating HTTP APIs

Creating Socket APIs

Managing APIs with PM2

Development

  1. Install Node.js.
  2. npm i -g lsc
  3. Run npm install inside the Service's root directory to install its dependencies.

Tests

npm test

LoopBack

Current Tags

  • 4.7.0                                ...           latest (15 days ago)

44 Versions

  • 4.7.0                                ...           15 days ago
  • 4.6.0                                ...           15 days ago
  • 4.5.5                                ...           25 days ago
  • 4.5.4                                ...           a month ago
  • 4.5.3                                ...           a month ago
  • 4.5.2                                ...           2 months ago
  • 4.5.1                                ...           2 months ago
  • 4.5.0                                ...           2 months ago
  • 4.4.0                                ...           2 months ago
  • 4.3.0                                ...           2 months ago
  • 4.2.0                                ...           3 months ago
  • 4.1.1                                ...           3 months ago
  • 4.1.0                                ...           3 months ago
  • 4.0.11                                ...           3 months ago
  • 4.0.10                                ...           3 months ago
  • 4.0.9                                ...           3 months ago
  • 4.0.8                                ...           4 months ago
  • 4.0.7                                ...           4 months ago
  • 4.0.6                                ...           4 months ago
  • 4.0.5                                ...           4 months ago
  • 4.0.4                                ...           4 months ago
  • 4.0.3                                ...           4 months ago
  • 3.4.2                                ...           4 months ago
  • 4.0.2                                ...           4 months ago
  • 4.0.1                                ...           4 months ago
  • 4.0.0                                ...           4 months ago
  • 3.4.1                                ...           6 months ago
  • 3.3.3                                ...           a year ago
  • 3.3.2                                ...           2 years ago
  • 3.3.1                                ...           2 years ago
  • 3.3.0                                ...           2 years ago
  • 3.2.1                                ...           2 years ago
  • 3.2.0                                ...           2 years ago
  • 3.1.0                                ...           2 years ago
  • 3.0.0                                ...           2 years ago
  • 2.0.0                                ...           2 years ago
  • 1.18.514                                ...           2 years ago
  • 0.18.514                                ...           2 years ago
  • 0.18.304                                ...           2 years ago
  • 0.18.222                                ...           2 years ago
  • 0.17.1023                                ...           3 years ago
  • 0.17.824                                ...           3 years ago
  • 0.17.510                                ...           3 years ago
  • 0.17.219                                ...           3 years ago
Downloads
Today 0
This Week 1
This Month 1
Last Day 1
Last Week 45
Last Month 130
Dependencies (43)
Dependents (1)

Copyright 2014 - 2017 © taobao.org |