USupport-api-gateway/swagger.js at development · UNICEFECAR/USupport-api-gateway · 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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
import swaggerAutogen from "swagger-autogen";

const outputFile = "./swaggerOutput.json";
const endpointsFiles = ["./routes/v1/*Router.js"];

const HOST_URL = process.env.HOST_URL;

const doc = {
  info: {
    version: "1.0.0",
    title: "REST API",
    description: "The Microservices API of the USupport Platform",
  },
  host: HOST_URL,
  basePath: "/api/v1",
  schemes: ["http", "https"],
  consumes: ["application/json"],
  produces: ["application/json"],
  tags: [
    {
      name: "Admin",
      description: "Admin Microservice",
    },
    {
      name: "Client",
      description: "Client Microservice",
    },
    {
      name: "Email",
      description: "Email Microservice",
    },
    {
      name: "Messaging",
      description: "Messaging Microservice",
    },
    {
      name: "Notifications",
      description: "Notifications Microservice",
    },
    {
      name: "Payments",
      description: "Payments Microservice",
    },
    {
      name: "Provider",
      description: "Provider Microservice",
    },
    {
      name: "User",
      description: "User Microservice",
    },
    {
      name: "Video",
      description: "Video Microservice",
    },
  ],
  securityDefinitions: {
    AnyAdminBearer: {
      type: "apiKey",
      in: "header",
      name: "Authorization",
      description:
        "Please enter into the field the word 'Bearer' following by space and JWT",
    },
    CountryAdminBearer: {
      type: "apiKey",
      in: "header",
      name: "Authorization",
      description:
        "Please enter into the field the word 'Bearer' following by space and JWT",
    },
    GlobalAdminBearer: {
      type: "apiKey",
      in: "header",
      name: "Authorization",
      description:
        "Please enter into the field the word 'Bearer' following by space and JWT",
    },
    AnyUserBearer: {
      type: "apiKey",
      in: "header",
      name: "Authorization",
      description:
        "Please enter into the field the word 'Bearer' following by space and JWT",
    },
    ClientBearer: {
      type: "apiKey",
      in: "header",
      name: "Authorization",
      description:
        "Please enter into the field the word 'Bearer' following by space and JWT",
    },
    ProviderBearer: {
      type: "apiKey",
      in: "header",
      name: "Authorization",
      description:
        "Please enter into the field the word 'Bearer' following by space and JWT",
    },
  },
};

swaggerAutogen(outputFile, endpointsFiles, doc);