FIFTEEN_BACK/swagger.js at main · SHOPFIFTEEN/FIFTEEN_BACK · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

'use strict';
module.exports = {
    swaggerDefinition: {
        openapi : "3.0.0", //우리가 사용하고 있는 Open Api 버전
        // Api에 필요한 정보를 다룸(선택필드)
        info: {
            title: 'Express Service with Swagger', //Api 제목
            version: '1.0.0', //api 버전
            description: 'a Rest api using swagger and express.' //api 상세정보
        },
        // 주소
        host: "localhost:3000/api-docs",
        // 기본 root path
        basePath: "/",
        contact: {
            email: "[email protected]"
        },

        securityDefinitions : {
            bearerAuth : {
                type : 'apikey',
                name : 'Authorization',
                scheme : 'bearer',
                in : 'header'

            },
            security : [
                { jwt : [] }
            ]
        },

        // 각 api에서 설명을 기록할 때 사용할 constant들을 미리 등록해놓는것
        components: {
            res: {
                BadRequest: {
                    description: '잘못된 요청.',
                    schema: {
                        $ref: '#/components/errorResult/Error'
                    }
                },
                Forbidden: {
                    description: '권한이 없음.',
                    schema: {
                        $ref: '#/components/errorResult/Error'
                    }
                },
                NotFound: {
                    description: '없는 리소스 요청.',
                    schema: {
                        $ref: '#/components/errorResult/Error'
                    }
                }
            },
            errorResult: {
                Error: {
                    type: 'object',
                    properties: {
                        errMsg: {
                            type: 'string',
                            description: '에러 메시지 전달.'
                        }
                    }
                }
            }
        },
        schemes: ["http", "https"], // 가능한 통신 방식
        definitions:  // 모델 정의 (User 모델에서 사용되는 속성 정의) - 여기서 정의하는 db모델정보나,
                      // components에 작성하는 정의들은 모든 API들에 '공통'으로 적용할 수 있는 내용들이다.
                      // 각각의 API 문서 정의에서 $ref로 접근하여 사용할 수 있다.
            {
                'User': {
                    type: 'object',
                    properties: {
                        id: {
                            type: 'string'
                        },
                        age: {
                            type: 'integer'
                        },
                        addr: {
                            type: 'string'
                        }
                    }
                }
            }
    },
    apis: ['./routes/**/*.js'] // api 파일 위치들
};