@4geit/swg-account-path

add an account endpoint to your API

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@4geit/swg-account-path
Minified + gzip package size for @4geit/swg-account-path in KB

Readme

@4geit/swg-account-path npm version


add an account endpoint to your API

Installation

  1. A recommended way to install @4geit/swg-account-path is through npm package manager using the following command:
npm i @4geit/swg-account-path --save

Or use yarn using the following command:

yarn add @4geit/swg-account-path
  1. In your swagger file, you need to add a reference to the SwgAccountPath definition under the paths property (e.g. /api/swagger/swagger.yaml) as below:
swagger: "2.0"
# ...
paths:
  /account:
    $ref: ../../node_modules/@4geit/swg-account-path/swagger.yaml#/definitions/SwgAccountPath
# ...

And you will also need to add the path to the controllers folder of the swg-account-path package so that swagger-node will find the relevant controller to use. Edit the file /config/default.yaml and add two new paths to the properties mockControllersDirs and controllersDirs as illustrated below:

swagger:
  # ...
  bagpipes:
    _router:
      # ...
      mockControllersDirs:
        # ...
        - node_modules/@4geit/swg-account-path/mocks
        # ...
      controllersDirs:
        # ...
        - node_modules/@4geit/swg-account-path/controllers
        # ...

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.