no-sql/swagger.js at main · salimskander/no-sql · 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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
const swaggerJsDoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');

const options = {
  definition: {
    openapi: '3.0.0',
    info: {
      title: 'API de Gestion de Profils',
      version: '1.0.0',
      description: 'API RESTful pour gérer des profils utilisateurs avec leurs expériences, compétences et relations',
      contact: {
        name: 'Support API',
        email: 'support@api-profiles.com'
      }
    },
    servers: [
      {
        url: 'http://localhost:3000',
        description: 'Serveur de développement'
      }
    ],
    components: {
      schemas: {
        Profile: {
          type: 'object',
          required: ['name', 'email'],
          properties: {
            _id: {
              type: 'string',
              description: 'ID unique du profil'
            },
            name: {
              type: 'string',
              description: 'Nom de l\'utilisateur'
            },
            email: {
              type: 'string',
              description: 'Email de l\'utilisateur'
            },
            experience: {
              type: 'array',
              items: {
                type: 'object',
                properties: {
                  _id: {
                    type: 'string',
                    description: 'ID unique de l\'expérience'
                  },
                  titre: {
                    type: 'string',
                    description: 'Titre du poste'
                  },
                  entreprise: {
                    type: 'string',
                    description: 'Nom de l\'entreprise'
                  },
                  dates: {
                    type: 'string',
                    description: 'Période de l\'expérience'
                  },
                  description: {
                    type: 'string',
                    description: 'Description de l\'expérience'
                  }
                }
              }
            },
            skills: {
              type: 'array',
              items: {
                type: 'string'
              },
              description: 'Liste des compétences'
            },
            information: {
              type: 'object',
              properties: {
                bio: {
                  type: 'string',
                  description: 'Biographie de l\'utilisateur'
                },
                localisation: {
                  type: 'string',
                  description: 'Localisation de l\'utilisateur'
                },
                siteWeb: {
                  type: 'string',
                  description: 'Site web de l\'utilisateur'
                }
              }
            },
            friends: {
              type: 'array',
              items: {
                type: 'string'
              },
              description: 'Liste des IDs des amis'
            },
            isDeleted: {
              type: 'boolean',
              description: 'Indique si le profil est supprimé'
            },
            dateCreation: {
              type: 'string',
              format: 'date-time',
              description: 'Date de création du profil'
            }
          }
        },
        Error: {
          type: 'object',
          properties: {
            message: {
              type: 'string'
            }
          }
        }
      }
    }
  },
  apis: ['./api/profiles/index.js', './routes.js']
};

const specs = swaggerJsDoc(options);

module.exports = function(app) {
  app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs, {
    customCss: '.swagger-ui .topbar { display: none }',
    customCssUrl: '/assets/swagger-custom.css'
  }));
};