Git Product home page Git Product logo

employees_api's Introduction

Employees API

Needs Docker installed to run

Business Requirements

As a restaurant owner, I need to keep a list of my employees so I can integrate into my enterprise application systems for HR purposes.
The working service should allow basic CRUD operations for employee records via HTTP API

Clone repository in target path

git clone https://github.com/mitekk/clar-gil.palikaras.git

Rename .env.example to .env

.env

Run Docker containers

In the project root directory run this to create containers and run them in background:

docker-compose up -d --build 

Requests

The main URL for requests is this:

http://localhost:8081/api/v1/

Get all employees or by ID (GET):

http://localhost:8081/api/v1/employees/:employeeID

Create an employee (POST):

http://localhost:8081/api/v1/employee

In request body, add data:

{ "name": "Bill", "email": "[email protected]", "dob": "1985-01-24", "department": "sales", "supervisor": 1, "userId": 1, "status": "pending" }

Update an employee (PUT):

http://localhost:8081/api/v1/employee

In request body, add data:

{ "employeeId": 2, "name": "Bill", "email": "[email protected]", "dob": "1985-01-24", "department": "sales", "supervisor": 1, "userId": 1, "status": "pending" }

Delete an employees or by ID (DELETE):

http://localhost:8081/api/v1/employee/:employeeID

employees_api's People

Contributors

geepalik avatar mitekk avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.