3.0.18 • Published 3 days ago

@zowe/apiml-onboarding-enabler-nodejs v3.0.18

Weekly downloads
-
License
EPL-2.0
Repository
github
Last release
3 days ago

Onboarding Node.js enabler for Zowe API Mediation Layer

This is the onboarding Node.js enabler for Zowe API Mediation Layer (part of Zowe) that allows to register a NodeJS based service to the API Mediation Layer Discovery Service. It uses eureka-js-client.

How to use

  1. Install the onboarding Node.js enabler package as a dependency of your service:

    npm i @zowe/apiml-onboarding-enabler-nodejs --dev-save

  2. Inside your Node.js service index.js, add the following code block to register your service with Eureka:

    const apiLayerService = require("@zowe/apiml-onboarding-enabler-nodejs");
    tlsOptions = apiLayerService.tlsOptions;
    const httpsServer = https.createServer(tlsOptions, app);
    httpsServer.listen(args.port, function () {
        apiLayerService.connectToEureka();
    });

    To make sure that your application will automatically unregister from Eureka once shut down, you can use the unregisterFromEureka() function, like shown in the example below. Example:

    process.on('SIGINT', signal => {
        apiLayerService.unregisterFromEureka();
        httpsServer.close(() => {
            process.exit(0);
        });
    });   
        
  3. Create a yaml file named service-configuration.yml, add the configuration properties and place the yaml file inside a /config directory at the same level of your index.js. Below is an example of the configuration.

    **Example:**
    
    ```yaml
    serviceId: hwexpress
    title: Hello World express REST API
    eureka:
      ssl: true
      host: localhost
      ipAddress: 127.0.0.1
      port: 10011
      servicePath: '/eureka/apps/'
      maxRetries: 30
      requestRetryDelay: 1000
      registryFetchInterval: 5
    
    
    description: Hello World REST API Service implemented in Express and Node.js
    baseUrl: https://localhost:10020/hwexpress
    homePageRelativeUrl: https://localhost:10020/
    statusPageRelativeUrl: https://localhost:10020/info
    healthCheckRelativeUrl: https://localhost:10020/status
    discoveryServiceUrls:
      - https://localhost:10011/eureka
    routes:
      - gatewayUrl: /api/v1
        serviceRelativeUrl: /api/v1
    apiInfo:
      - apiId: org.zowe.hwexpress
        gatewayUrl: "api/v1"
        swaggerUrl: https://localhost:10020/swagger.json
    catalogUiTile:
      id: cademoapps
      title: Sample API Mediation Layer Applications
      description: Applications which demonstrate how to make a service integrated to the API Mediation Layer ecosystem
      version: 1.0.0
    instance:
      app: hwexpress
      vipAddress: hwexpress
      instanceId: localhost:hwexpress:10020
      homePageUrl: https://localhost:10020/
      hostName: 'localhost'
      ipAddr: '127.0.0.1'
      secureVipAddress: hwexpress
      port:
        $: 10020
        '@enabled': false
      securePort:
        $: 10020
        '@enabled': "true"
    
      dataCenterInfo:
        '@class': com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo
        name: MyOwn
      metadata:
        apiml.catalog.tile.id: 'samplenodeservice'
        apiml.catalog.tile.title: 'Zowe Sample Node Service'
        apiml.catalog.tile.description: 'NodeJS Sample service running'
        apiml.catalog.tile.version: '1.0.0'
        apiml.routes.api_v1.gatewayUrl: "api/v1"
        apiml.routes.api_v1.serviceUrl: "/api/v1"
        apiml.apiInfo.0.apiId: org.zowe.hwexpress
        apiml.apiInfo.0.gatewayUrl: "api/v1"
        apiml.apiInfo.0.swaggerUrl: https://localhost:10020/swagger.json
        apiml.service.title: 'Zowe Sample Node Service'
        apiml.service.description: 'The Proxy Server is an HTTP HTTPS, and Websocket server built upon NodeJS and ExpressJS.'
    
    ssl:
      certificate: ssl/localhost.keystore.cer
      keystore: ssl/localhost.keystore.key
      caFile: ssl/localhost.pem
      keyPassword: password
    
    ```
  4. Start your Node.js service and verify that it registers to the Zowe API Mediation Layer.

3.0.18

3 days ago

3.0.13

6 days ago

3.0.16

5 days ago

3.0.17

5 days ago

3.0.14

6 days ago

3.0.15

6 days ago

2.15.2

6 days ago

3.0.12

10 days ago

2.15.0

12 days ago

2.15.1

12 days ago

3.0.11

17 days ago

3.0.10

24 days ago

3.0.9

1 month ago

3.0.8

1 month ago

1.28.25

2 months ago

3.0.7

2 months ago

3.0.6

2 months ago

3.0.5

2 months ago

3.0.4

2 months ago

3.0.3

3 months ago

2.14.1

3 months ago

2.14.0

3 months ago

2.13.9

3 months ago

3.0.2

3 months ago

3.0.1

3 months ago

2.13.8

3 months ago

2.13.7

4 months ago

2.13.6

4 months ago

2.13.4

4 months ago

2.13.5

4 months ago

2.13.3

4 months ago

2.13.2

4 months ago

2.13.0

4 months ago

2.13.1

4 months ago

2.12.8

4 months ago

2.12.7

5 months ago

2.12.6

5 months ago

2.12.5

5 months ago

2.12.4

5 months ago

2.12.3

5 months ago

2.11.0

7 months ago

2.11.1

7 months ago

2.11.8

6 months ago

2.11.9

6 months ago

2.11.6

6 months ago

2.11.7

6 months ago

2.11.4

7 months ago

2.11.5

7 months ago

2.11.2

7 months ago

2.11.3

7 months ago

2.11.10

5 months ago

2.9.12

10 months ago

2.9.13

9 months ago

2.9.10

10 months ago

2.9.11

10 months ago

2.9.16

9 months ago

2.9.14

9 months ago

2.9.15

9 months ago

2.10.1

9 months ago

2.10.2

8 months ago

2.10.0

9 months ago

2.10.5

7 months ago

2.10.3

8 months ago

2.10.4

8 months ago

1.28.23

8 months ago

1.28.24

7 months ago

2.9.9

10 months ago

2.9.6

10 months ago

2.9.8

10 months ago

2.9.7

10 months ago

2.12.0

5 months ago

2.12.1

5 months ago

2.12.2

5 months ago

2.9.5

11 months ago

1.28.22

11 months ago

2.9.0

12 months ago

2.9.2

11 months ago

2.9.1

12 months ago

2.9.4

11 months ago

2.9.3

11 months ago

2.8.18

12 months ago

2.8.17

12 months ago

2.8.16

1 year ago

2.8.7

1 year ago

2.8.9

1 year ago

2.8.8

1 year ago

2.8.12

1 year ago

2.8.11

1 year ago

2.8.10

1 year ago

2.8.15

1 year ago

2.8.14

1 year ago

2.8.13

1 year ago

1.28.17

1 year ago

1.28.18

1 year ago

1.28.19

1 year ago

1.28.20

1 year ago

1.28.21

1 year ago

2.7.0

1 year ago

2.7.2

1 year ago

2.7.1

1 year ago

2.8.6

1 year ago

2.7.4

1 year ago

2.7.3

1 year ago

2.7.6

1 year ago

2.7.5

1 year ago

2.4.1

1 year ago

2.4.0

1 year ago

2.4.3

1 year ago

2.4.2

1 year ago

2.4.5

1 year ago

2.4.4

1 year ago

1.27.23

2 years ago

1.27.22

2 years ago

1.27.25

2 years ago

1.27.24

2 years ago

1.27.21

2 years ago

1.27.20

2 years ago

2.5.5

1 year ago

1.28.16

1 year ago

2.3.0

2 years ago

2.3.2

2 years ago

2.3.1

2 years ago

2.3.4

2 years ago

2.3.3

2 years ago

2.3.6

2 years ago

2.3.5

2 years ago

1.28.12

2 years ago

1.28.13

2 years ago

1.28.14

1 year ago

1.28.15

1 year ago

1.28.10

2 years ago

1.28.11

2 years ago

2.2.3

2 years ago

2.2.5

2 years ago

2.2.4

2 years ago

2.2.7

2 years ago

2.2.6

2 years ago

2.3.8

2 years ago

2.3.7

2 years ago

2.3.9

2 years ago

2.1.2

2 years ago

2.1.1

2 years ago

2.1.4

2 years ago

2.1.3

2 years ago

2.1.6

2 years ago

2.1.5

2 years ago

2.1.7

2 years ago

1.27.19

2 years ago

1.27.18

2 years ago

1.27.17

2 years ago

2.2.9

2 years ago

2.2.8

2 years ago

2.0.7

2 years ago

2.0.9

2 years ago

2.0.8

2 years ago

2.6.1

1 year ago

2.6.0

1 year ago

2.6.3

1 year ago

2.2.11

2 years ago

2.6.2

1 year ago

2.2.10

2 years ago

2.5.0

1 year ago

2.5.2

1 year ago

2.5.1

1 year ago

2.5.4

1 year ago

2.5.3

1 year ago

1.28.1

2 years ago

1.28.2

2 years ago

1.28.0

2 years ago

1.28.5

2 years ago

1.28.6

2 years ago

1.28.3

2 years ago

1.28.4

2 years ago

1.28.9

2 years ago

1.28.7

2 years ago

1.28.8

2 years ago

2.3.17

2 years ago

2.3.16

2 years ago

2.3.19

1 year ago

2.3.18

1 year ago

2.3.13

2 years ago

2.3.12

2 years ago

2.3.15

2 years ago

2.3.14

2 years ago

2.3.11

2 years ago

2.3.10

2 years ago

2.0.3

2 years ago

2.0.5

2 years ago

2.0.4

2 years ago

2.0.6

2 years ago

2.0.1

2 years ago

1.26.7

2 years ago

1.26.8

2 years ago

1.26.9

2 years ago

0.0.9

2 years ago

0.0.8

2 years ago

1.26.19

2 years ago

1.26.18

2 years ago

2.0.2-PR-1964-1

2 years ago

1.26.15

2 years ago

1.26.14

2 years ago

1.26.17

2 years ago

1.26.16

2 years ago

1.26.10

2 years ago

1.27.2

2 years ago

1.27.3

2 years ago

1.27.1

2 years ago

1.27.6

2 years ago

1.27.7

2 years ago

1.27.4

2 years ago

1.27.5

2 years ago

1.27.8

2 years ago

1.27.9

2 years ago

1.26.22

2 years ago

1.26.21

2 years ago

0.1.7

3 years ago

1.26.24

2 years ago

1.26.23

2 years ago

1.26.20

2 years ago

1.27.0-SNAPSHOT

2 years ago

1.27.16

2 years ago

1.27.15

2 years ago

0.2.1

3 years ago

0.2.0

3 years ago

1.27.12

2 years ago

0.2.7

2 years ago

1.27.11

2 years ago

0.2.6

3 years ago

1.27.13

2 years ago

0.2.3

3 years ago

0.2.2

3 years ago

1.27.10

2 years ago

0.2.5

3 years ago

0.2.4

3 years ago

0.1.4

3 years ago

0.1.3

3 years ago

0.1.6

3 years ago

0.1.5

3 years ago

0.1.2

3 years ago

0.1.0

3 years ago

0.1.1

3 years ago

0.0.60

3 years ago

0.0.59

3 years ago

0.0.58

3 years ago

0.0.57

3 years ago

0.0.56

3 years ago

0.0.55

3 years ago

1.24.1

3 years ago

1.23.8

3 years ago

1.24.0

3 years ago

1.23.7

3 years ago

1.23.6

3 years ago

1.23.5

3 years ago

1.23.4

3 years ago

1.23.3

3 years ago

1.23.2

3 years ago

1.23.0

3 years ago

1.23.1

3 years ago

1.22.3-1-6-2021

3 years ago

1.22.4

3 years ago

0.0.40

3 years ago

0.0.41

3 years ago

0.0.42

3 years ago

0.0.43

3 years ago

0.0.44

3 years ago

0.0.45

3 years ago

1.22.1-PR1470

3 years ago

0.0.38

3 years ago

0.0.39

3 years ago

1.21.10

3 years ago

1.21.11

3 years ago

1.21.12

3 years ago

1.22.0

3 years ago

1.22.3

3 years ago

1.22.1

3 years ago

1.22.2

3 years ago

1.22.0-PR1446-1

3 years ago

1.22.0-PR1446-2

3 years ago

1.22.0-PR1446-3

3 years ago

1.22.0-PR1446-4

3 years ago

1.22.0-PR1446-5

3 years ago

1.22.0-PR1446-6

3 years ago

1.22.0-PR1446-7

3 years ago

1.21.8

3 years ago

1.21.9

3 years ago

1.21.7

3 years ago

1.21.6

3 years ago

1.21.5

3 years ago

1.21.4

3 years ago

1.21.3

3 years ago

1.21.2

3 years ago

1.20.19

3 years ago

1.21.1

3 years ago

0.0.30

3 years ago

0.0.31

3 years ago

0.0.32

3 years ago

0.0.10

3 years ago

0.0.33

3 years ago

0.0.34

3 years ago

0.0.36

3 years ago

0.0.37

3 years ago

0.0.29

3 years ago

1.20.0

3 years ago

1.19.2

3 years ago