https://github.com/luke3butler/feathers-versionate

Create and work with nested services.
https://github.com/luke3butler/feathers-versionate

api api-management feathers feathers-service feathers-versionate feathersjs nested-services nesting prefix routes

Last synced: 3 months ago
JSON representation

Create and work with nested services.

• Host: GitHub
• URL: https://github.com/luke3butler/feathers-versionate
• Owner: luke3butler
• License: mit
• Created: 2017-06-10T00:00:14.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T20:29:33.000Z (over 1 year ago)
• Last Synced: 2024-03-17T14:21:53.226Z (4 months ago)
• Topics: api, api-management, feathers, feathers-service, feathers-versionate, feathersjs, nested-services, nesting, prefix, routes
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/feathers-versionate
• Size: 571 KB
• Stars: 28
• Watchers: 4
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-feathersjs - feathers-versionate - Utility for creating and working with nested service paths. (Plugins / Utilities)

README

        

# feathers-versionate

## About

> Service nesting for feathersjs

Nests services under configurable base paths, and provides easy methods to access those services.

## Getting Started

Install the module  

NPM: `npm install feathers-versionate --save`  

Yarn: `yarn add feathers-versionate`

```js

var feathers = require('feathers');

var versionate = require('feathers-versionate');

var memory = require('feathers-memory');

const app = feathers();

// Configure versionate

app.configure(versionate());

// Register a base-path "/api/v2", and provide access to it via `app.v2`

app.versionate('v2', '/api/v2/');

// Now you can use `app.v2` to create and access services under the registered path!

app.v2.use('/users', memory); // http://localhost:3030/api/v2/users

// We can access services easily too!

const userService = app.v2.service('users');

```

## Documentation

`feathers-versionate` It a utility that creates wrappers for app.use and app.service with nested root paths.

* `app.versionate(name, basePath)`

* `app.versionate.register(name, basePath)` (app.versionate alias)

`feathers-versionate` services

* `app.versionateName.use(path, service)` 

  - wraps `app.use` and includes the versionate basePath behind the scenes

* `app.versionateName.service(path)` 

  - wraps `app.service` and includes the versionate basePath behind the scenes

### Examples

```js

const app = feathers();

// Configure versionate

app.configure(versionate());

// Register a versionate base paths

app.versionate('v1', '/api/v1/');

// You can register as many "versionations" as you'd like

app.versionate('v2', '/api/v2/');

// If the 3rd argument is set to true, the service will be nested under app.versionate

app.versionate('docs', 'docs', true);

// Nesting under versionate is useful if you don't want to pollute `app` with lots of children

app.versionate.docs.use('quick-guide');

// Once registered, you can use app.versionateName anywhere in your app!

app.v1.use('/users', userServiceV1);

app.v2.use('/users', userServiceV2);

// Retrieve a service through the versionate name

const usersV2 = app.v2.service('users');

// You can also access services by their full path on app.service

const usersV1 = app.service('/api/v1/users');

// Use the service just like normal

usersV2.find().then(items => console.log('.find()', items));

```

## Release History

__0.2.2__

- Fix/add support for win32 systems

__0.2.0__

- Add app.versionate as main function

- Add tests

- Fix app.versionate nesting of service access methods

__0.1.0__

- Initial release

- Support for app.use and app.service