Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/basemax/simplefastpyapi
This is a simple REST API built with Python and FastAPI and SQLAlchemy for CRUD operations (Create, Read, Update, Delete) on users. FastAPI is a powerful web framework for building APIs.
https://github.com/basemax/simplefastpyapi
api api-restful fastapi fastapi-crud fastapi-example fastapi-py fastapi-python fastapi-sample fastapi-user fastapi-users py python python-fastapi python3 restful restful-api sqlalchemy
Last synced: about 7 hours ago
JSON representation
This is a simple REST API built with Python and FastAPI and SQLAlchemy for CRUD operations (Create, Read, Update, Delete) on users. FastAPI is a powerful web framework for building APIs.
- Host: GitHub
- URL: https://github.com/basemax/simplefastpyapi
- Owner: BaseMax
- License: gpl-3.0
- Created: 2023-04-08T17:25:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-06T00:29:39.000Z (3 months ago)
- Last Synced: 2024-09-24T19:27:56.868Z (about 7 hours ago)
- Topics: api, api-restful, fastapi, fastapi-crud, fastapi-example, fastapi-py, fastapi-python, fastapi-sample, fastapi-user, fastapi-users, py, python, python-fastapi, python3, restful, restful-api, sqlalchemy
- Language: Python
- Homepage:
- Size: 45.9 KB
- Stars: 22
- Watchers: 4
- Forks: 16
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple FastAPI Py
## My Awesome FastAPI Project
This is a simple REST API built with Python and FastAPI and SQLAlchemy for CRUD operations (Create, Read, Update, Delete) on users.
FastAPI is a powerful web framework for building APIs.
## Installation
Clone this repository to your local machine:
```bash
git clone https://github.com/BaseMax/SimpleFastPyAPI
```
Change into the project directory:
```bash
cd SimpleFastPyAPI
```
Install the project dependencies:
```bash
pip install -r requirements.txt
```
Run the application:
```bash
uvicorn main:app --reload
```
The application will start and be available at http://localhost:8000.
## API Endpoints
### Retrieve a list of users:
```http
GET /users
```
Returns a list of all users in the system:
```console
curl http://localhost:8000/users/ -H "Accept: application/json"
```
Response:
```json
[
{
"email": "[email protected]",
"id": 1,
"password": "password1",
"name": "Alice"
},
{
"email": "[email protected]",
"id": 2,
"password": "password2",
"name": "Bob"
},
{
"email": "[email protected]",
"id": 3,
"password": "password3",
"name": "Charlie"
}
]
```
### Retrieve details for a specific user:
```http
GET /users/{user_id}
```
Returns details for a specific user with the given user_id:
```console
curl http://localhost:8000/users/1 -H "Accept: application/json"
```
Response:
```json
{
"email": "[email protected]",
"id": 1,
"password": "password1",
"name": "Alice"
}
```
### Add a new user
```http
POST /users
```
Adds a new user to the system. The request body should include a JSON object with the following properties:
- `name` (string, required): the name of the user
- `email` (string, required): the email address of the user
- `password` (string, required): the password for the user
```console
curl -X POST http://localhost:8000/users/
-H 'Content-Type: application/json'
-d '{"name":"Ali","password":"123456", "email": "[email protected]"}'
```
Response:
```json
{
"email": "[email protected]",
"password": "123456",
"id": 4,
"name": "Ali"
}
```
### Update an existing user
```http
PUT /users/{user_id}
```
Updates an existing user with the given user_id. The request body should include a JSON object with the following properties:
- `name` (string): the new name for the user
- `email` (string): the new email address for the user
```console
curl -X PUT http://localhost:8000/users/1
-H "Accept: application/json"
-d '{"name": "Reza", "email": "[email protected]"}'
```
Response:
```json
{"message": "User updated successfully"}
```
### Delete a user
```http
DELETE /users/{user_id}
```
Deletes the user with the given user_id:
```console
curl -X DELETE http://localhost:8000/2
```
Response:
```json
{"message": "User deleted successfully"}
```
## License
This project is licensed under the GPL-3.0 License - see the LICENSE file for details.
Copyright 2023, Max Base