https://github.com/pdpschoolteam/fastapi-model
FastApi pydantic model
https://github.com/pdpschoolteam/fastapi-model
fastapi pydantic python3
Last synced: about 2 months ago
JSON representation
FastApi pydantic model
- Host: GitHub
- URL: https://github.com/pdpschoolteam/fastapi-model
- Owner: PDPSchoolTeam
- Created: 2025-04-03T04:19:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-09T05:43:25.000Z (about 1 year ago)
- Last Synced: 2025-04-09T16:44:30.807Z (about 1 year ago)
- Topics: fastapi, pydantic, python3
- Language: Python
- Homepage:
- Size: 1.95 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PDP School API LMS
Bu FastAPI asosidagi API, maktab uchun ta'lim boshqaruv tizimi (LMS). Bu API, maktablar va o'quvchilarni boshqarish uchun nuqta nuqtalarini taqdim etadi, shu jumladan yangi yozuvlar yaratish va ismga asoslangan ma'lumotlarni olish.
## Xususiyatlar
- **Barcha maktablarni olish**: Baza ichidagi barcha maktablarni ko'rsatish.
- **Yangi maktab yaratish**: Maktabni nomi, xonasi va o'qituvchisi bilan qo'shish.
- **Maktabni nomi bo'yicha olish**: Maxsus maktabni nomiga qarab olish.
- **Barcha o'quvchilarni olish**: Baza ichidagi barcha o'quvchilarni ko'rsatish.
- **Yangi o'quvchi yaratish**: Yangi o'quvchi qo'shish, ism, email, xona va o'qishga qabul qilingan sana bilan.
- **O'quvchini nomi bo'yicha olish**: Maxsus o'quvchini ismi bilan olish.
## O'rnatish
Ushbu loyihani lokalda ishga tushirish uchun:
1. Repozitoriyani klonlash:
```bash
git clone https://github.com/PDPSchoolTeam/FastApi-model.git
cd school-api
```
2. Virtual muhit yaratish:
```bash
python3 -m venv venv
source venv/bin/activate # Windows uchun: `venv\Scripts\activate`
```
3. Bog'liqliklarni o'rnatish:
```bash
pip install -r requirements.txt
```
4. Ilovani ishga tushirish:
```bash
uvicorn main:app --reload
```
## API Endpoints
### Maktablar
```bash
GET /api/school: Barcha maktablarni olish.
POST /api/school: Yangi maktab yaratish.
GET /api/school/{school_name}: Maktabni nomi bo'yicha olish.
```
### O'quvchilar
```bash
GET /api/student: Barcha o'quvchilarni olish.
POST /api/student: Yangi o'quvchi yaratish.
GET /api/student/{student_name}: O'quvchini nomi bo'yicha olish.
```
### Misol
Barcha o'quvchilarni olish uchun:
```bash
GET http://127.0.0.1:8000/api/student
```
Yangi o'quvchi yaratish:
```bash
POST http://127.0.0.1:8000/api/student
Content-Type: application/json
{
"name": "John Doe",
"email": "john.doe@example.com",
"room_id": 101,
"since": "2022-01-01"
}
```
## Litsenziya
Ushbu loyiha MIT litsenziyasi ostida litsenziyalanadi - tafsilotlar uchun LICENSE faylini ko'rib chiqing.
Bu `README.md` fayli sizning GitHub'dagi loyihangizni boshqalar uchun tushunarli qilishga yordam beradi.