Skip to content

Commit 22905ab

Browse files
committed
docs: corregir errores en todos .md para el backend arrojados por Markdown linter in vs-code
- se adiciono la documentacion faltante para el Gateway - se arreglaron los problemas de identacion de todos los .md de cada uno de los microservicios
1 parent 3860835 commit 22905ab

File tree

5 files changed

+232
-24
lines changed

5 files changed

+232
-24
lines changed

backend/docs/Auth-Service.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Auth-Service
22

33
## Descripción General
4+
45
El `auth-service` es un microservicio responsable de gestionar la autenticación de usuarios, incluyendo inicio de sesión, validación de tokens y cierre de sesión. Utiliza FastAPI para la capa de API e integra una base de datos PostgreSQL para los datos de los usuarios.
56

67
---
@@ -22,49 +23,61 @@ El `auth-service` es un microservicio responsable de gestionar la autenticación
2223
## Descripción de Archivos
2324

2425
### 1. `models/schemas.py`
26+
2527
- Contiene modelos de Pydantic para la validación de solicitudes y respuestas.
2628
- Ejemplo:
29+
2730
```python
2831
class LoginRequest(BaseModel):
2932
username: str
3033
password: str
3134
```
3235

3336
### 2. `utils/db.py`
37+
3438
- Maneja las conexiones y consultas a la base de datos.
3539
- Ejemplo:
40+
3641
```python
3742
def get_connection():
3843
"""Establece una conexión con la base de datos PostgreSQL."""
3944
```
4045

4146
### 3. `utils/jwt_manager.py`
47+
4248
- Administra los JSON Web Tokens (JWT) para la autenticación.
4349
- Ejemplo:
50+
4451
```python
4552
def generate_token(data: dict) -> str:
4653
"""Genera un JWT con la carga útil proporcionada."""
4754
```
4855

4956
### 4. `utils/dependencies.py`
57+
5058
- Proporciona dependencias reutilizables para las rutas de FastAPI, como la validación de tokens.
5159
- Ejemplo:
60+
5261
```python
5362
def get_current_user(token: str = Depends(oauth2_scheme)):
5463
"""Extrae el usuario actual del token JWT."""
5564
```
5665

5766
### 5. `auth_service.py`
67+
5868
- Implementa la lógica principal de autenticación, incluyendo inicio de sesión y validación de tokens.
5969
- Ejemplo:
70+
6071
```python
6172
def login(self, username: str, password: str) -> str | None:
6273
"""Autentica a un usuario y genera un token JWT."""
6374
```
6475

6576
### 6. `main.py`
77+
6678
- Define la aplicación FastAPI y las rutas para el servicio de autenticación.
6779
- Ejemplo:
80+
6881
```python
6982
@router.post("/login", response_model=TokenResponse)
7083
def login_route(request: LoginRequest):
@@ -94,4 +107,4 @@ El `auth-service` es un microservicio responsable de gestionar la autenticación
94107

95108
- **Seguridad**: Asegúrate de que el `JWT_SECRET` se almacene de forma segura (por ejemplo, en variables de entorno).
96109
- **Escalabilidad**: El servicio está diseñado para ser sin estado, lo que lo hace escalable.
97-
- **Extensibilidad**: Es fácil agregar nuevos métodos de autenticación o backends de bases de datos.
110+
- **Extensibilidad**: Es fácil agregar nuevos métodos de autenticación o backends de bases de datos.

backend/docs/DocumentService.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
1-
```markdown
21
# Document Service
32

43
El microservicio **Document Service** es responsable de gestionar documentos, permitiendo su creación, listado y eliminación. Este servicio está construido con **FastAPI** y utiliza **SQLAlchemy** para la gestión de la base de datos.
54

65
## Endpoints
76

87
### 1. Subir Documento
8+
99
**POST** `/api/documents/`
1010

1111
Sube un nuevo documento al sistema.
1212

13-
#### Parámetros:
13+
#### Parámetros
14+
1415
- `nombre` (form-data, requerido): Nombre del documento.
1516
- `proyecto_id` (form-data, requerido): ID del proyecto asociado.
1617
- `archivo` (form-data, requerido): Archivo a subir.
1718

18-
#### Respuesta:
19+
#### Respuesta
20+
1921
- **200 OK**: Devuelve el documento creado.
2022
- **Ejemplo de respuesta:**
23+
2124
```json
2225
{
2326
"id": 1,
@@ -30,13 +33,16 @@ Sube un nuevo documento al sistema.
3033
---
3134

3235
### 2. Listar Documentos
36+
3337
**GET** `/api/documents/`
3438

3539
Obtiene una lista de todos los documentos almacenados.
3640

37-
#### Respuesta:
41+
#### Respuesta - Listar Documentos
42+
3843
- **200 OK**: Devuelve una lista de documentos.
3944
- **Ejemplo de respuesta:**
45+
4046
```json
4147
[
4248
{
@@ -51,17 +57,21 @@ Obtiene una lista de todos los documentos almacenados.
5157
---
5258

5359
### 3. Eliminar Documento
60+
5461
**DELETE** `/api/documents/{doc_id}`
5562

5663
Elimina un documento por su ID.
5764

58-
#### Parámetros:
65+
#### Parámetros - Eliminar Documento
66+
5967
- `doc_id` (path, requerido): ID del documento a eliminar.
6068

61-
#### Respuesta:
69+
#### Respuesta - Eliminar Documento
70+
6271
- **200 OK**: Documento eliminado exitosamente.
6372
- **404 Not Found**: Si el documento no existe.
6473
- **Ejemplo de respuesta:**
74+
6575
```json
6676
{
6777
"msg": "Documento eliminado"
@@ -72,7 +82,6 @@ Elimina un documento por su ID.
7282

7383
## Estructura del Proyecto
7484

75-
```
7685
backend/
7786
└── api/
7887
└── Documents-service/
@@ -84,9 +93,9 @@ backend/
8493
│ └── document_schema.py
8594
└── routes/
8695
└── document_routes.py
87-
```
8896

89-
### Archivos principales:
97+
### Archivos principales
98+
9099
- **`database.py`**: Configuración de la base de datos SQLite y creación de la sesión.
91100
- **`document_service.py`**: Punto de entrada del microservicio.
92101
- **`document_routes.py`**: Define los endpoints del servicio.
@@ -129,10 +138,13 @@ def notify(action: str, doc_id: int):
129138

130139
1. Clona el repositorio.
131140
2. Instala las dependencias:
141+
132142
```bash
133143
pip install -r requirements.txt
134144
```
145+
135146
3. Ejecuta el servicio:
147+
136148
```bash
137149
uvicorn document_service:app --reload
138150
```
@@ -145,4 +157,4 @@ def notify(action: str, doc_id: int):
145157
- **SQLAlchemy**: ORM para la gestión de la base de datos.
146158
- **Pydantic**: Validación de datos.
147159

148-
---
160+
---

backend/docs/ExternalToolService.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
```markdown
21
# ExternalToolService
32

43
El servicio `ExternalToolService` es una aplicación basada en FastAPI que proporciona una interfaz para interactuar con herramientas externas como servicios de inteligencia artificial, procesamiento de pagos y almacenamiento en la nube.
54

65
## Estructura del Proyecto
76

8-
```
97
ExternalToolService/
108
├── app/
119
│ ├── app/
@@ -16,49 +14,48 @@ ExternalToolService/
1614
│ │ │ ├── payment.py
1715
│ │ │ ├── storage.py
1816
│ │ ├── main.py
19-
```
2017

2118
### Archivos Principales
2219

2320
#### `main.py`
2421

2522
Este archivo define las rutas principales de la API y gestiona la autenticación básica.
2623

27-
- **Rutas**:
24+
- __Rutas__:
2825
- `POST /analyze`: Analiza datos utilizando un servicio de inteligencia artificial.
2926
- `POST /pay`: Procesa pagos utilizando un adaptador de pago.
3027
- `GET /storage-url`: Genera una URL de almacenamiento para un archivo.
3128

32-
- **Autenticación**:
29+
- __Autenticación__:
3330
Utiliza autenticación básica con un usuario y contraseña predeterminados (`admin` y `123`).
3431

3532
#### `adapters/manager.py`
3633

3734
Define la clase base `ExternalTool` y el gestor `ExternalToolManager` para interactuar con herramientas externas.
3835

39-
- **Clases**:
36+
- __Clases__:
4037
- `ExternalTool`: Clase abstracta que define el método `execute`.
4138
- `ExternalToolManager`: Clase que utiliza herramientas externas para ejecutar operaciones.
4239

4340
#### `adapters/ai.py`
4441

4542
Implementa el adaptador `AIServiceAdapter` para servicios de inteligencia artificial.
4643

47-
- **Método**:
44+
- __Método__:
4845
- `execute(data)`: Devuelve un resumen y un análisis de sentimiento del contenido proporcionado.
4946

5047
#### `adapters/payment.py`
5148

5249
Implementa el adaptador `PaymentAdapter` para procesamiento de pagos.
5350

54-
- **Método**:
51+
- __Método__:
5552
- `execute(data)`: Simula el procesamiento de un pago y devuelve el estado.
5653

5754
#### `adapters/storage.py`
5855

5956
Implementa el adaptador `CloudStorageAdapter` para generar URLs de almacenamiento.
6057

61-
- **Método**:
58+
- __Método__:
6259
- `execute(data)`: Genera una URL simulada para un archivo.
6360

6461
## Ejemplo de Uso
@@ -90,23 +87,26 @@ curl -X GET "http://localhost:8000/storage-url?filename=example.txt" \
9087

9188
## Requisitos
9289

93-
- **Python**: 3.8 o superior
94-
- **Dependencias**: FastAPI, Uvicorn
90+
- __Python__: 3.8 o superior
91+
- __Dependencias__: FastAPI, Uvicorn
9592

9693
## Instalación
9794

9895
1. Clona el repositorio:
96+
9997
```bash
10098
git clone <url-del-repositorio>
10199
cd ExternalToolService/app
102100
```
103101

104102
2. Instala las dependencias:
103+
105104
```bash
106105
pip install -r requirements.txt
107106
```
108107

109108
3. Ejecuta el servidor:
109+
110110
```bash
111111
uvicorn main:app --reload
112112
```
@@ -115,4 +115,3 @@ curl -X GET "http://localhost:8000/storage-url?filename=example.txt" \
115115

116116
- Este servicio utiliza autenticación básica para proteger las rutas.
117117
- Los adaptadores implementan lógica simulada y pueden extenderse para integrarse con servicios reales.
118-
```

0 commit comments

Comments
 (0)