kth-node-api-key-strategy

    2.0.0 • Public • Published

    kth-node-api-key-strategy Build Status

    A api key strategy for Node applications.

    Configure

    serverSettings.js

    module.exports = {
      secure: {
        api_keys: [
          {name: 'devClient', apikey: '1234567', scope: ['write', 'read']},
          {name: 'testClient', apikey: '891011', scope: ['read']}
          {name: 'publicClient', apikey: '0000', scope: ['readPublic']}
        ],
      }
    };
    

    swagger.js

    Setting security on a route

    "/v1/some/route/{id}": {
          "get": {
            "operationId": "",
            "summary": "",
            "description": "",
            "parameters": [],
            "tags": [
              "v1"
            ],
            "responses": { ... },
            "security": {
              "api_key": [
                "read"
              ]
            }
          }
        }
    

    Defining security definition

    "securityDefinitions": {
        "api_key": {
          "type": "apiKey",
          "name": "api_key",
          "in": "header",
          "scopes": {
            "read": "Read access to data",
            "write": "Write access to data",
            "readPublic": "Read only access to publicly visible data",
          }
        }
      }
    

    Install

    npm i kth-node-api-key-strategy

    DownloadsWeekly Downloads

    20

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    12.1 kB

    Total Files

    14

    Last publish

    Collaborators

    • kthwebmaster
    • wkchung
    • exacs
    • ssundkvist
    • kth-ci
    • emilstenberg