acm-udayton / acm-udayton/ACM-Meeting-Records

[FEATURE] Create RESTful /api/v1 endpoints for application

Abierto
#162 0 comentarios 0 reacciones 0 asignados Ver en GitHub
backend enhancement
Lenguaje dominante
Python
Estrellas
7
Forks
2
Merge medio
4 d 23 h
PR fusionados (30 d)
2

Descripción

## Feature Description

Create new blueprints for /api/v1 endpoints that mirror the existing endpoints in the existing non-API application.

Use pydantic for request and response schema and also be sure to use `app.register_api_blueprint()` to register these blueprints so that Swagger UI (#161) can document the API automatically.

All business logic should come from existing services or be placed in new services, as per #160.

## Why It's Worth Implementing

This is key to being able to decouple the frontend from the backend in `v2.0`.

---

## Acceptance Criteria & Solution Requirements
*To close this issue, the following must be met (can be finalized in the comments):*
- [ ] 1. Application runs as expected with the new feature integrated seamlessly.
- [ ] 2. Code quality metrics are maintained, and linting has been considered in development.
- [ ] 3. Testing metrics are maintained, and tests have been updated/added wherever relevant during development.
- [ ] 4. Documentation has been updated to reflect the changes made during development.
- [ ] 5. All application functionality can now be accessed from the new RESTful API.
- [ ] 6. Use services (#160) for all business logic.
- [ ] 7. JWT authentication has been implemented (#154)

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.