A api key strategy for Node API projects.
npm install kth-node-api-key-strategy#### 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",
}
}
}