serverless-apikey-output

v0.1.0

A serverless plugin to output api key values

NPM

README

GitHub

MIT

Latest version published 4 months ago

    npm install serverless-apikey-output

We couldn't find any similar packages Browse all packages

Package Health Score

52 / 100

Popularity
Limited
Maintenance
Inactive
Security
No known security issues
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (102)

Dependents: 0
GitHub Stars: 0
Forks: 0
Contributors: 1

The npm package serverless-apikey-output receives a total of 102 downloads a week. As such, we scored serverless-apikey-output popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package serverless-apikey-output, we found that it has been starred ? times, and that 0 other projects on the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.1.0

Indirect Vulnerabilities

0.1.0

License Risks

0.1.0

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security Policy: No

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like serverless-apikey-output is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test serverless-apikey-output

Fix it in your project with Snyk!

Maintenance

Inactive

Commit Frequency

Open Issues: 0
Merged PR: 0
Open PR: 0
Last Commit: 4 months ago

Further analysis of the maintenance status of serverless-apikey-output based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that serverless-apikey-output demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No
License: MIT

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like serverless-apikey-output is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 4 months
Dependencies: 2 Direct / 20 Total
Versions: 2
Install Size: 26.5 kB
Dist-tags: 1
# of Files: 12
Maintainers: 1
TS Typings: Yes

We detected a total of 20 direct & transitive dependencies for serverless-apikey-output. See the full dependency tree of serverless-apikey-output

serverless-apikey-output has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Serverless Api Key Output Plugin

A serverless plugin to store an API Key and it's value from your AWS CloudFormation Stack in a JSON file.

Warning!

Do not commit an API Key to your repo!

Usage

Install

$ npm install serverless-apikey-output

$ yarn add serverless-apikey-output

Configuration

plugins:
  - serverless-apikey-output

custom:
  output:
    keys: #optional: the default is to export all api keys
      - MyApiKeyName # this is the apikey "name" -- not to be confused with the cloudformation logicalId
    file: .build/stack.json # optional: the default path is '.serverless-apikey-output/${self:provider.stage}.keys.json'

Example

The plugin works by listing all resources of type "AWS::ApiGateway::ApiKey" after deployment, so it will pick up any created API Key.

Serverless.yml

service: apikey-example
provider:
  name: aws
  runtime: nodejs12.x
  apiKeys:
    - myapikey
    - ${self:provider.stage}-test-key

plugins:
  - serverless-apikey-output

functions:
  test:
    handler: handler.test
    events:
      - https:
          path: test
          method: get

custom:
  apiKeyOutput:
    keys:
      - ${self:provider.stage}-test-key # only export one of the two keys created
    file: test-keys/${self:provider.stage}.keys.json

Output Sample

[
    {
        "id": "<Physical APIKey Id>",
        "value": "<Api Key Value>",
        "name": "dev-test-key",
        "enabled": true,
        "createdDate": "2020-09-15T07:24:38.000Z",
        "lastUpdatedDate": "2020-09-15T07:24:38.000Z",
        "stageKeys": [
            "<ApiGatewayId>/dev"
        ],
        "tags": {
            "STAGE": "dev"
        }
    }
]