updated docs
This commit is contained in:
@@ -0,0 +1,6 @@
|
||||
## Todo Lists
|
||||
|
||||
1. Endpoint uuid must be imported from a common folder
|
||||
2. Auth Service must be seperated from application checkers service even though it serves values from redis
|
||||
3. Initial services are not functioning well enough
|
||||
4. ApiResponse and SystemResponse must be seperated
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# Providers
|
||||
|
||||
- Email Provider
|
||||
|
||||
- Mongo Provider
|
||||
|
||||
- Postgres Provider
|
||||
|
||||
- Redis Provider
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
# Initializers of API
|
||||
|
||||
Main components that are need to start API
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
# Middlewares
|
||||
|
||||
- Token Middleware : between request and response checks token is valid or not
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
# Modules
|
||||
|
||||
Modules that are created from any controllers that are implmented inside API
|
||||
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
# Validations
|
||||
|
||||
Validations that are used inside API endpoints
|
||||
|
||||
41
docs/apiDocs/api_env.env
Normal file
41
docs/apiDocs/api_env.env
Normal file
@@ -0,0 +1,41 @@
|
||||
MONGO_ENGINE=mongodb
|
||||
MONGO_DB=appdb
|
||||
MONGO_HOST=10.10.2.13
|
||||
MONGO_PORT=27017
|
||||
MONGO_USER=appuser
|
||||
MONGO_AUTH_DB=appdb
|
||||
MONGO_PASSWORD=apppassword
|
||||
|
||||
POSTGRES_USER=postgres
|
||||
POSTGRES_PASSWORD=password
|
||||
POSTGRES_DB=postgres
|
||||
POSTGRES_HOST=10.10.2.14
|
||||
POSTGRES_PORT=5432
|
||||
POSTGRES_ENGINE=postgresql+psycopg2
|
||||
POSTGRES_POOL_PRE_PING=True
|
||||
POSTGRES_POOL_SIZE=20
|
||||
POSTGRES_MAX_OVERFLOW=10
|
||||
POSTGRES_POOL_RECYCLE=600
|
||||
POSTGRES_POOL_TIMEOUT=30
|
||||
POSTGRES_ECHO=True
|
||||
|
||||
REDIS_HOST=10.10.2.15
|
||||
REDIS_PASSWORD=your_strong_password_here
|
||||
REDIS_PORT=6379
|
||||
REDIS_DB=0
|
||||
|
||||
API_ACCESS_EMAIL_EXT=evyos.com.tr
|
||||
API_ALGORITHM=HS256
|
||||
API_ACCESS_TOKEN_LENGTH=90
|
||||
API_REFRESHER_TOKEN_LENGTH=144
|
||||
API_EMAIL_HOST=10.10.2.36
|
||||
API_DATETIME_FORMAT=YYYY-MM-DD HH:mm:ss Z
|
||||
API_FORGOT_LINK=https://www.evyos.com.tr/password/create?tokenUrl=
|
||||
API_VERSION=0.1.001
|
||||
API_ACCESS_TOKEN_TAG=eys-acs-tkn
|
||||
|
||||
EMAIL_HOST=10.10.2.34
|
||||
EMAIL_USERNAME=karatay@mehmetkaratay.com.tr
|
||||
EMAIL_PASSWORD=system
|
||||
EMAIL_PORT=587
|
||||
EMAIL_SEND=0
|
||||
27
docs/apiDocs/pyproject.toml
Normal file
27
docs/apiDocs/pyproject.toml
Normal file
@@ -0,0 +1,27 @@
|
||||
[project]
|
||||
name = "prod-wag-backend-automate-services"
|
||||
version = "0.1.0"
|
||||
description = "Add your description here"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.12"
|
||||
dependencies = [
|
||||
"alembic>=1.15.2",
|
||||
"arrow>=1.3.0",
|
||||
"cryptography>=44.0.2",
|
||||
"faker>=37.1.0",
|
||||
"fastapi>=0.115.12",
|
||||
"pandas>=2.2.3",
|
||||
"prometheus-fastapi-instrumentator>=7.1.0",
|
||||
"psycopg2-binary>=2.9.10",
|
||||
"pydantic-settings>=2.8.1",
|
||||
"pymongo>=4.11.3",
|
||||
"pytest>=8.3.5",
|
||||
"redbox>=0.2.1",
|
||||
"redis>=5.2.1",
|
||||
"redmail>=0.6.0",
|
||||
"requests>=2.32.3",
|
||||
"sqlalchemy-mixins>=2.0.5",
|
||||
"textdistance>=4.6.3",
|
||||
"unidecode>=1.3.8",
|
||||
"uvicorn>=0.34.0",
|
||||
]
|
||||
@@ -0,0 +1,3 @@
|
||||
# Schemas
|
||||
|
||||
Database Schemas that are used inside API endpoints
|
||||
|
||||
Reference in New Issue
Block a user