chen/taskmanager
1
0
Fork 0
Code Issues 11 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

[��ǿ] API �ĵ����� #10

New Issue
Open
opened 2026-03-19 07:56:42 +00:00 by chen · 0 comments
chen commented 2026-03-19 07:56:42 +00:00
Owner
Copy Link

��������

���� Swagger/OpenAPI �Զ����� API �ĵ�������ǰ�˿����� API ���ԡ�

ʵ��Ҫ��

���ˣ�NestJS��

  • ��װ Swagger ������@nestjs/swagger��
  • �� main.ts ������ Swagger
  • Ϊ���� Controller ���� @ApiTags
  • Ϊ���� DTO ���� @ApiProperty װ����
  • Ϊ��֤�ӿ����� @ApiBearerAuth
  • ���� API �ĵ�����·����/api/docs��
  • ���� API ��Ӧʾ��

�ĵ�����

  • �û���֤ API

    • POST /api/auth/register
    • POST /api/auth/login
    • GET /api/auth/me

  • �������� API

    • POST /api/tasks
    • GET /api/tasks
    • GET /api/tasks/:id
    • PUT /api/tasks/:id
    • DELETE /api/tasks/:id
    • PATCH /api/tasks/:id/status
    • POST /api/tasks/:id/archive
    • POST /api/tasks/:id/unarchive

  • ��ǩ���� API

    • POST /api/tags
    • GET /api/tags
    • POST /api/tasks/:id/tags
    • DELETE /api/tasks/:id/tags/:tagId

���ձ�׼

  • ? ���� /api/docs ���Կ��� Swagger UI
  • ? ���� API �˵㶼���ĵ�
  • ? ���� DTO �����ֶ�˵��
  • ? ������ Swagger UI �в��� API
  • ? ��֤�ӿ�֧�� Bearer Token
  • ? �ĵ�������������Ӧʾ��

������ϵ

Ԥ�ƹ�����

2-3 Сʱ

## �������� ���� Swagger/OpenAPI �Զ����� API �ĵ�������ǰ�˿����� API ���ԡ� ## ʵ��Ҫ�� ### ���ˣ�NestJS�� - [ ] ��װ Swagger ������@nestjs/swagger�� - [ ] �� main.ts ������ Swagger - [ ] Ϊ���� Controller ���� @ApiTags - [ ] Ϊ���� DTO ���� @ApiProperty װ���� - [ ] Ϊ��֤�ӿ����� @ApiBearerAuth - [ ] ���� API �ĵ�����·����/api/docs�� - [ ] ���� API ��Ӧʾ�� ### �ĵ����� - [ ] �û���֤ API - POST /api/auth/register - POST /api/auth/login - GET /api/auth/me - [ ] �������� API - POST /api/tasks - GET /api/tasks - GET /api/tasks/:id - PUT /api/tasks/:id - DELETE /api/tasks/:id - PATCH /api/tasks/:id/status - POST /api/tasks/:id/archive - POST /api/tasks/:id/unarchive - [ ] ��ǩ���� API - POST /api/tags - GET /api/tags - POST /api/tasks/:id/tags - DELETE /api/tasks/:id/tags/:tagId ## ���ձ�׼ - ? ���� /api/docs ���Կ��� Swagger UI - ? ���� API �˵㶼���ĵ� - ? ���� DTO �����ֶ�˵�� - ? ������ Swagger UI �в��� API - ? ��֤�ӿ�֧�� Bearer Token - ? �ĵ�������������Ӧʾ�� ## ������ϵ - **ǰ�� Issue**: #1, #2, #3, #4, #5, #6, #7, #8, #9 - **���� Issue**: �� ## Ԥ�ƹ����� 2-3 Сʱ
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: chen/taskmanager#10
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?