Narcoleptic Pasta Manufacturer

    @4geit/swg-product-model

    1.32.0 • Public • Published

    @4geit/swg-product-model npm version


    product model and endpoints

    Installation

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

    Or use yarn using the following command:

    yarn add @4geit/swg-product-model
    1. In your swagger file, you need to add a reference to the SwgProductModel definition under the definitions property (e.g. /api/swagger/swagger.yaml) as below:
    swagger: "2.0"
    # ...
    definitions:
      SwgProductModel:
        $ref: ../../node_modules/@4geit/swg-product-model/swagger.yaml#/definitions/SwgProductModel
    # ...
    1. SwgProductModel also comes along with some endpoints you can expose to the API, to do so you will need to add a reference to the SwgProductModel definition under the paths property (e.g. /api/swagger/swagger.yaml) as below:
    swagger: "2.0"
    # ...
    paths:
      /product:
        $ref: ../../node_modules/@4geit/swg-product-model/swagger.yaml#/definitions/ProductListPath
      /product/{id}:
        $ref: ../../node_modules/@4geit/swg-product-model/swagger.yaml#/definitions/ProductItemPath
      /product/populate:
        $ref: ../../node_modules/@4geit/swg-product-model/swagger.yaml#/definitions/PopulatePath
    # ...

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

    Keywords

    none

    Install

    npm i @4geit/swg-product-model

    DownloadsWeekly Downloads

    34

    Version

    1.32.0

    License

    MIT

    Last publish

    Collaborators

    • geraldinestarke
    • fabianstarke
    • canercandan