updated docs

This commit is contained in:
Berkay 2025-05-29 20:28:31 +03:00
parent 01b2786fde
commit 7d9c8ed57d
12 changed files with 166 additions and 1 deletions

View File

@ -6,4 +6,4 @@
## Backend Docs:
[Backend](./docs/back.md)
[Backend](./docs/api.md)

View File

@ -0,0 +1,3 @@
# API
API documentation

View File

@ -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

View File

@ -0,0 +1,9 @@
# Providers
- Email Provider
- Mongo Provider
- Postgres Provider
- Redis Provider

View File

@ -0,0 +1,3 @@
# Initializers of API
Main components that are need to start API

View File

@ -0,0 +1,5 @@
# Middlewares
- Token Middleware : between request and response checks token is valid or not

View File

@ -0,0 +1,4 @@
# Modules
Modules that are created from any controllers that are implmented inside API

View File

@ -0,0 +1,3 @@
# Validations
Validations that are used inside API endpoints

View File

@ -0,0 +1,3 @@
# Schemas
Database Schemas that are used inside API endpoints

View File

@ -0,0 +1,129 @@
services:
email_service:
container_name: email_service
build:
context: .
dockerfile: BankServices/EmailService/Dockerfile
networks:
- bank-services-network
environment:
- MAILBOX=bilgilendirme@ileti.isbank.com.tr
- MAIN_MAIL=karatay.berkay@gmail.com
- INFO_MAIL=mehmet.karatay@hotmail.com
- EMAIL_HOST=10.10.2.34
- EMAIL_USERNAME=isbank@mehmetkaratay.com.tr
- EMAIL_PASSWORD=system
- EMAIL_PORT=993
- EMAIL_SEND_PORT=587
- EMAIL_SLEEP=60
- AUTHORIZE_IBAN=4245-0093333
- REDIS_HOST=10.10.2.15
- REDIS_PORT=6379
- REDIS_PASSWORD=your_strong_password_here
restart: unless-stopped
volumes:
- tempory-email-service:/tmp
logging:
driver: "json-file"
options:
max-size: "10m"
max-file: "3"
parser_service:
container_name: parser_service
build:
context: .
dockerfile: BankServices/ParserService/Dockerfile
networks:
- bank-services-network
environment:
- REDIS_HOST=10.10.2.15
- REDIS_PORT=6379
- REDIS_PASSWORD=your_strong_password_here
restart: unless-stopped
logging:
driver: "json-file"
options:
max-size: "10m"
max-file: "3"
writer_service:
container_name: writer_service
build:
context: .
dockerfile: BankServices/WriterService/Dockerfile
networks:
- bank-services-network
environment:
- REDIS_HOST=10.10.2.15
- REDIS_PORT=6379
- REDIS_PASSWORD=your_strong_password_here
- DB_HOST=10.10.2.14
- DB_PORT=5432
- DB_USER=postgres
- DB_PASSWORD=password
- DB_NAME=postgres
restart: unless-stopped
logging:
driver: "json-file"
options:
max-size: "10m"
max-file: "3"
routine_email_service:
container_name: routine_email_service
build:
context: .
dockerfile: BankServices/RoutineEmailService/Dockerfile
entrypoint: ["/entrypoint.sh"]
networks:
- bank-services-network
environment:
- EMAIL_HOST=10.10.2.34
- EMAIL_USERNAME=karatay@mehmetkaratay.com.tr
- EMAIL_PASSWORD=system
- EMAIL_PORT=587
- EMAIL_SEND=1
- DB_HOST=10.10.2.14
- DB_PORT=5432
- DB_USER=postgres
- DB_PASSWORD=password
- DB_NAME=postgres
restart: unless-stopped
logging:
driver: "json-file"
options:
max-size: "10m"
max-file: "3"
sender_service:
container_name: sender_service
build:
context: .
dockerfile: BankServices/SenderService/Dockerfile
networks:
- bank-services-network
environment:
- EMAIL_HOST=10.10.2.34
- EMAIL_USERNAME=karatay@mehmetkaratay.com.tr
- EMAIL_PASSWORD=system
- EMAIL_PORT=587
- EMAIL_SEND=1
- DB_HOST=10.10.2.14
- DB_PORT=5432
- DB_USER=postgres
- DB_PASSWORD=password
- DB_NAME=postgres
restart: unless-stopped
logging:
driver: "json-file"
options:
max-size: "10m"
max-file: "3"
networks:
bank-services-network:
driver: bridge
volumes:
tempory-email-service: