https://github.com/mirsahib/stibodx
Api Usage
https://github.com/mirsahib/stibodx
Last synced: 7 months ago
JSON representation
Api Usage
- Host: GitHub
- URL: https://github.com/mirsahib/stibodx
- Owner: mirsahib
- Created: 2024-02-01T13:20:31.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-01T13:23:23.000Z (over 1 year ago)
- Last Synced: 2025-01-25T11:43:19.332Z (9 months ago)
- Language: TypeScript
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# API Usage Guide
## Description
This repository provides a set of RESTful APIs for user management. The APIs allow you to perform basic CRUD operations on user data, including creating a new user, retrieving all users, retrieving a specific user, updating a user, and deleting a user.
## Video
Youtube: https://youtu.be/0XFqZYgFRh4
## Installation
To run this project locally, follow these steps:
1. Clone the Git repository:
```bash
git clone https://github.com/mirsahib/stiboDx.git
```
2. Installation
```bash
cd stiboDx
docker-compose up
```
## API Table
| API Path | Params | Expected Response |
| ------------------------ | ---------------------------------------------------------------- | ----------------------------------------------------- |
| `POST /api/users` | JSON payload: `{ "firstName", "lastName", "password", "email" }` | Successful creation of a new user. |
| `GET /api/users` | None | List of all users. |
| `GET /api/users/{id}` | None | Details of a specific user identified by `{id}`. |
| `PUT /api/users/{id}` | JSON payload: `{ "user", "email" }` | Successful update of the user identified by `{id}`. |
| `DELETE /api/users/{id}` | None | Successful deletion of the user identified by `{id}`. |
## Usage
```
curl -X POST http://localhost:3000/api/users -H "Content-Type: application/json" -d '{"firstName": "John", "lastName": "Doe", "password": "securepassword", "email": "john.doe@example.com"}'
```