splitwise-node/swagger.js at master · shraddha46/splitwise-node · 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
const swaggerJsdoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');

const options = {
  definition: {
    openapi: '3.0.0',
    info: {
      title: 'Splitwise APIs',
      version: '1.0.0',
      description: 'Splitwise API documentation',
    },
    servers: [
      {
        url: 'http://localhost:3001/api',
        description: 'API server'
      },
    ],
    components: {
      securitySchemes: {
        BearerAuth: {
          type: 'http',
          scheme: 'bearer',
          bearerFormat: 'JWT',
        },
      },
      schemas: {
        Expense: {
          type: 'object',
          properties: {
            id: {
              type: 'string',
              description: 'The auto-generated id of the expense',
            },
            description: {
              type: 'string',
              description: 'The description of the expense',
            },
            amount: {
              type: 'number',
              description: 'The amount of the expense',
            },
            date: {
              type: 'string',
              format: 'date',
              description: 'The date of the created expense',
            }
          }
        }
      }
    },
    security: [],
  },
  apis: ['./Routes/*.js'], // Path to the API docs
};

const specs = swaggerJsdoc(options);

module.exports = {
  swaggerUi,
  specs,
};