Git Product home page Git Product logo

nobleosinachi / employeewebapi Goto Github PK

View Code? Open in Web Editor NEW
4.0 1.0 1.0 624 KB

This project is a practical learning exercise that demonstrates the fundamentals of building a robust Employee Management Web API using ASP .NET. Through this repository, I explore the essential concepts and best practices required to create a functional API that performs CRUD operations (Create, Read, Update, Delete) on employee data.

Home Page: https://nobleosinachi.github.io/EmployeeWebAPI/

License: MIT License

ASP.NET 0.03% C# 41.47% CSS 0.64% HTML 4.40% JavaScript 53.47%
asp-net crud-operations data-persistence employee-management entity-framework error-handling input-validation salary-management web-api

employeewebapi's Introduction

Employee Web API Demo

Used to fetch the database of employees to be used in another front-end employee management & payroll system. This project helped me understand the basics of creating a Web API and testing it using Postman.

Bootstrapped with the default MVC project template, it only has one Employee model class, with an EmployeeController for performing the CRUD (Create Read Update Delete) operations.

Installation

To run the Employee-Web API Demo locally, follow these steps:

  1. Clone the repository to your local machine using the following command:
git clone https://github.com/your-username/Employee-Web-API-Demo.git
  1. Change into the project directory:
cd Employee-Web-API-Demo
  1. Install the required dependencies:
dotnet restore
  1. Start the development server:
dotnet run
  1. The API will be accessible at http://localhost:5000 by default.

Usage

The Employee-Web API provides the following endpoints:

  • GET /api/employees: Get a list of all employees.
  • GET /api/employees/{id}: Get a specific employee by ID.
  • POST /api/employees: Add a new employee to the database.
  • PUT /api/employees/{id}: Update an existing employee's information.
  • DELETE /api/employees/{id}: Delete an employee from the database.

You can use tools like Postman to test these endpoints and interact with the API.

Contributing

Contributions are welcome! If you'd like to contribute to the project, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch with a descriptive name for your feature or bug fix.
  4. Make your changes and commit them with descriptive commit messages.
  5. Push your changes to your forked repository on GitHub.
  6. Submit a pull request to the main repository.

Please ensure that your code adheres to the project's coding standards and practices.

License

This project is licensed under the MIT License - see the LICENSE file for details.

employeewebapi's People

Contributors

nobleosinachi avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

teshomegit

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.