https://github.com/roninjosue/users-api

https://github.com/roninjosue/users-api

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/roninjosue/users-api
• Owner: roninJosue
• Created: 2023-12-16T07:02:43.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-17T18:38:54.000Z (about 1 year ago)
• Last Synced: 2024-11-11T12:13:30.313Z (3 months ago)
• Language: C#
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Users API

## Description

This is a example of a API REST with .NET Core and C# and MySQL 8.0

## Installation

1. Clone the repository `git clone https://github.com/roninJosue/users-api.git`

2. Navigate to project directory `cd users-api`

3. Install the necessary packages with `.NET CLI` `dotnet restore`

4. Create migrations `dotnet ef migrations add InitialCreate`

5. Update database `dotnet ef database update`

6. Run the project `dotnet run`

## Usage

Once the project is running, you can interact with the API using the following endpoints:

### Get All Users

`GET /api/users`

### Create a User

`POST /api/users`

## Dependencies

This project is developed with **ASP .NET Core** and **Entity Framework Core**. It uses the **Pomelo MySQL provider for

Entity Framework Core** as the data access layer.

You also need a local **MySQL Database Server** where the API will create and manipulate the user data. 

You can install [MySQL Server](https://dev.mysql.com/doc/mysql-installation-excerpt/8.0/en/) 

locally and [MySQL Workbench](https://www.mysql.com/products/workbench/) for a GUI to view and manage your databases.

You need to create a **users** database, the user root with password mOWzX86dYxuRj1ji, 

or any other password you configure in the MySQL installation

Please ensure all the dependencies are correctly installed and configured before running the project