virtus
669addf799
Build and Push Reader Image / docker (push) Failing after 22s
- Introduced a new batch import client for handling multiple EPUB files simultaneously. - Updated API routes for previewing and importing EPUB files, improving error handling and response management. - Enhanced genre management during import, allowing for dynamic creation and association of genres. - Implemented long-fetch handling to accommodate lengthy processing times for large EPUB files. - Refined UI components for better user experience in the import workflow.
1.6 KiB
1.6 KiB
API Contract Standard (Reader Suite)
Tai lieu contract chung cho reader, reader-app, reader-api.
Base and Versioning
- Base path:
/api/* - Current mode: unversioned with backward-compatible evolution.
- Breaking changes bat buoc qua ke hoach migration va release note.
Response Convention
- Success:
200/201: tra JSON payload domain data.204: khong co body.
- Error (standardized):
{
"code": "string",
"message": "human readable",
"details": {}
}
code: machine-friendly identifier (vd:UNAUTHORIZED,VALIDATION_ERROR,NOT_FOUND).message: thong diep nguoi dung/dev doc duoc.details: optional object cho field-level context.
HTTP Status Usage
400: input/validation khong hop le.401: chua dang nhap hoặc token/session invalid.403: da dang nhap nhung khong du quyen.404: resource khong ton tai.409: xung dot du lieu.422: payload format dung JSON nhung khong dat rule nghiep vu.500: loi he thong.410: (du tru) tai nguyen da go bo hoac khong con ho tro.
Pagination Convention
- Query params:
page(1-based)limit
- Response envelope:
{
"items": [],
"pagination": {
"page": 1,
"limit": 20,
"total": 0,
"totalPages": 0
}
}
Auth Matrix
- Web: NextAuth session cookie.
- Mobile: Bearer JWT.
- Backend phai map ca 2 vao cung user identity + role.
Compatibility Rules
- Khong xoa hoac doi y nghia field dang duoc client su dung.
- Field moi phai optional theo default trong giai doan rollout.
- Doi ten field => tao migration layer hoac add field moi, deprecate sau.
- Endpoint moi can update README + mapping matrix.