express-api-template/openapi.js at main · anthonysette/express-api-template · 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
//import models
const userModel = require("./src/models/user.json");

const config = require("./config");

module.exports = {
    openapi: "3.0.0",
    info: {
        title: "Express API Template",
        description:
            "This is Anthony Sette's preffered Express.js API Architecture. Try using this template on your next project!",
        version: "1.0.0",
    },
    servers: [
        {
            url: config.baseUrl + "/" + config.apiVersion,
            description: config.nodeEnv,
        },
    ],
    components: {
        schemas: {
            User: userModel,
        },
        responses: {
            400: {
                description: "Invalid request",
                content: {
                    "application/json": {
                        schema: {
                            type: "array",
                            items: {
                                type: "object",
                                properties: {
                                    value: {
                                        type: "string",
                                    },
                                    msg: {
                                        type: "string",
                                    },
                                    param: {
                                        type: "string",
                                    },
                                    location: {
                                        type: "string",
                                    },
                                },
                            },
                        },
                    },
                },
            },
            401: {
                description: "Unauthorized",
            },
            500: {
                description: "Server error, check logs.",
            },
        },
    },
    paths: {},
    tags: [
        {
            name: "Users",
            description:
                "These endpoints allow you to create and query users.",
        }
    ],
};