full-stack-fastapi-template OpenAPI & REST API Specification
Full-stack web application template with FastAPI, React, SQLModel, PostgreSQL, Vite, Tailwind CSS, shadcn/ui, FastAPI Cloud, and Docker Compose.
44,811 stars
TypeScript
1 file · ~2,954 tokens
#docker#docker-compose#fastapi#fastapi-cloud#full-stack#github-actions#jwt#openapi
full-stack-fastapi-template REST API Specification
Located in backend/app/api/routes/*.py (FastAPI / Python Routes) on branch main
3.0.0 (FastAPI / Python)
JSON
12 Endpoints
7.9 KB
Operations & Route Endpoints (20)
Raw JSON Specification
{
"openapi": "3.0.0",
"info": {
"title": "full-stack-fastapi-template REST API",
"version": "1.0.0",
"description": "OpenAPI 3.0.0 specification synthesized deterministically from FastAPI / Python router source definitions (20 routes discovered across 5 router files)."
},
"paths": {
"/login/login/access-token": {
"post": {
"summary": "POST /login/login/access-token",
"description": "Route definition extracted from `backend/app/api/routes/login.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
},
"/login/login/test-token": {
"post": {
"summary": "POST /login/login/test-token",
"description": "Route definition extracted from `backend/app/api/routes/login.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
},
"/login/password-recovery/{email}": {
"post": {
"summary": "POST /login/password-recovery/{email}",
"description": "Route definition extracted from `backend/app/api/routes/login.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
},
"/login/reset-password/": {
"post": {
"summary": "POST /login/reset-password/",
"description": "Route definition extracted from `backend/app/api/routes/login.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
},
"/login/password-recovery-html-content/{email}": {
"post": {
"summary": "POST /login/password-recovery-html-content/{email}",
"description": "Route definition extracted from `backend/app/api/routes/login.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
},
"/users/": {
"get": {
"summary": "GET /users/",
"description": "Route definition extracted from `backend/app/api/routes/users.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
},
"post": {
"summary": "POST /users/",
"description": "Route definition extracted from `backend/app/api/routes/users.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
},
"/users/me": {
"patch": {
"summary": "PATCH /users/me",
"description": "Route definition extracted from `backend/app/api/routes/users.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
},
"get": {
"summary": "GET /users/me",
"description": "Route definition extracted from `backend/app/api/routes/users.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
},
"delete": {
"summary": "DELETE /users/me",
"description": "Route definition extracted from `backend/app/api/routes/users.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
},
"/users/me/password": {
"patch": {
"summary": "PATCH /users/me/password",
"description": "Route definition extracted from `backend/app/api/routes/users.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
},
"/users/signup": {
"post": {
"summary": "POST /users/signup",
"description": "Route definition extracted from `backend/app/api/routes/users.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
},
"/users/{user_id}": {
"get": {
"summary": "GET /users/{user_id}",
"description": "Route definition extracted from `backend/app/api/routes/users.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
},
"patch": {
"summary": "PATCH /users/{user_id}",
"description": "Route definition extracted from `backend/app/api/routes/users.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
},
"delete": {
"summary": "DELETE /users/{user_id}",
"description": "Route definition extracted from `backend/app/api/routes/users.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
},
"/items/": {
"get": {
"summary": "GET /items/",
"description": "Route definition extracted from `backend/app/api/routes/items.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
},
"post": {
"summary": "POST /items/",
"description": "Route definition extracted from `backend/app/api/routes/items.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
},
"/items/{id}": {
"get": {
"summary": "GET /items/{id}",
"description": "Route definition extracted from `backend/app/api/routes/items.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
},
"put": {
"summary": "PUT /items/{id}",
"description": "Route definition extracted from `backend/app/api/routes/items.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
},
"delete": {
"summary": "DELETE /items/{id}",
"description": "Route definition extracted from `backend/app/api/routes/items.py`",
"responses": {
"200": {
"description": "Successful response"
},
"400": {
"description": "Bad request / validation error"
}
}
}
}
}
}