Skip to content

Commit 6d6f918

Browse files
committed
docs: Swagger 주석 수정 및 추가
1 parent 31b1a43 commit 6d6f918

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

src/routes/user.router.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ router.post('/qr-login', authMiddleware.login, userController.createToken);
131131

132132
/**
133133
* @swagger
134-
* /api/qr-login:
134+
* /qr-login:
135135
* get:
136136
* summary: QR 로그인 토큰 조회 및 자동 로그인 처리
137137
* tags: [QRLogin]
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,35 @@
11
import { BaseResponseDto } from '@/types/dto/responses/baseResponse.type';
22

3+
/**
4+
* @swagger
5+
* components:
6+
* schemas:
7+
* QRLoginTokenResponseData:
8+
* type: object
9+
* properties:
10+
* token:
11+
* type: string
12+
* minLength: 10
13+
* maxLength: 10
14+
* example: ABC123EFGH
15+
* description: QR 로그인용 10자리 토큰
16+
*/
317
type Token10 = string & { __lengthBrand: 10 };
418

519
export interface QRLoginTokenResponseData {
620
token: Token10;
721
}
822

23+
/**
24+
* @swagger
25+
* components:
26+
* schemas:
27+
* QRLoginTokenResponseDto:
28+
* allOf:
29+
* - $ref: '#/components/schemas/BaseResponseDto'
30+
* - type: object
31+
* properties:
32+
* data:
33+
* $ref: '#/components/schemas/QRLoginTokenResponseData'
34+
*/
935
export class QRLoginTokenResponseDto extends BaseResponseDto<QRLoginTokenResponseData> {}

0 commit comments

Comments
 (0)