@4geit/swg-account-model

swagger definition of an account model

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@4geit/swg-account-model
1.31.25 years ago5 years agoMinified + gzip package size for @4geit/swg-account-model in KB

Readme

@4geit/swg-account-model npm version
---
swagger definition of an account model following the REST CRUD pattern

Installation

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

npm i @4geit/swg-account-model --save

Or use yarn using the following command:
yarn add @4geit/swg-account-model

  1. In your swagger file, you need to add a reference to the SwgAccountModel definition under the definitions property (e.g. /api/swagger/swagger.yaml) as below:

swagger: "2.0"
# ...
definitions:
  SwgAccountModel:
    $ref: ../../node_modules/@4geit/swg-account-model/swagger.yaml#/definitions/SwgAccountModel
# ...

  1. In your swagger file, you need to add a reference to the PopulatePath definition under the paths property (e.g. /api/swagger/swagger.yaml) as below:

swagger: "2.0"
# ...
paths:
  /populate:
    $ref: ../../node_modules/@4geit/swg-account-model/swagger.yaml#/definitions/PopulatePath
  /users:
    $ref: ../../node_modules/@4geit/swg-account-model/swagger.yaml#/definitions/UsersPath
# ...

And you will also need to add the path to the controllers folder of the swg-account-model 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-model/mocks
        # ...
      controllersDirs:
        # ...
        - node_modules/@4geit/swg-account-model/controllers
        # ...