Nested Public Modules

    @4geit/swg-login-path

    1.31.0 • Public • Published

    @4geit/swg-login-path npm version


    set a login endpoint to your API

    Installation

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

    Or use yarn using the following command:

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

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

    Keywords

    none

    Install

    npm i @4geit/swg-login-path

    DownloadsWeekly Downloads

    30

    Version

    1.31.0

    License

    MIT

    Last publish

    Collaborators

    • geraldinestarke
    • fabianstarke
    • canercandan