User-Feature-Service-Api

A sample app to manage user access to new features

Project

Implementing a Node API with TypeScript in Serverless framework to manage users' accesses to new features via feature switches.

Getting Started

Clone the project repository by running the command below if you use SSH

git clone [email protected]:mdrijwan/user-feature-service.git

If you use https, use this instead

git clone https://github.com/mdrijwan/user-feature-service.git

Run the command below to install NPM dependencies

npm install

This project is built on stand alone TypeScript so no compilation needed. But you can compile the TypeScript files to JavaScript anyway

npm run compile

Don't forget to install dynamodb local

sls dynamodb install

Then start the server and follow the instructions in the console.

npm run start

Let's get started!

Methods

• To create/update user access

  • POST/features

  • Example Request:

    { 
    "featureName": "xxx", (string) 
    "email": "xxx", (string) (user's name) 
    "enable": true|false (boolean) (uses true to enable a user's access
    }
    

Example Response:

• Success - status OK (200)
• Failure - Status Not Modified (304)

Response Demo!

• To get user access (pass the params in query)
  • GET/features

  • Example: GET/localhost:3000/dev/feature?email=[email protected]&featureName=Tester

Request Demo!