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

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

未關閉
#162 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
backend enhancement
主要語言
Python
星號
7
分支
2
平均合併
4 天 23 小時
30 天內合併 PR
2

描述

## 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)

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。