-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.js
95 lines (91 loc) · 2.67 KB
/
swagger.js
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
const swaggerJSDoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');
const mongoose = require('mongoose');
const swaggerDefinition = {
openapi: '3.0.0',
info: {
title: 'API Documentation',
version: '1.0.0',
description: 'API documentation for Blog-it web application',
},
servers: [
{
url: 'https://blog-it-zjku.onrender.com',
},
],
components: {
schemas: {
User: {
type: 'object',
properties: {
_id: { type: 'string' },
username: { type: 'string' },
email: { type: 'string' },
password: { type: 'string' },
profilePicture: { type: 'string' },
bio: { type: 'string' },
isAdmin: { type: 'boolean' },
createdAt: { type: 'string', format: 'date-time' },
updatedAt: { type: 'string', format: 'date-time' },
},
required: ['username', 'email', 'password'],
},
Post: {
type: 'object',
properties: {
_id: { type: 'string' },
title: { type: 'string' },
body: { type: 'string' },
author: { $ref: '#/components/schemas/User' },
categories: { type: 'array', items: { type: 'string' } },
comments: { type: 'array', items: { type: 'string' } },
image: { type: 'string' },
fileUrl: { type: 'string' },
createdAt: { type: 'string', format: 'date-time' },
updatedAt: { type: 'string', format: 'date-time' },
},
required: ['title', 'body', 'author'],
},
Comment: {
type: 'object',
properties: {
_id: { type: 'string' },
body: { type: 'string' },
username: { type: 'string' },
author: { $ref: '#/components/schemas/User' },
post: { $ref: '#/components/schemas/Post' },
createdAt: { type: 'string', format: 'date-time' },
updatedAt: { type: 'string', format: 'date-time' },
},
required: ['body', 'username', 'author', 'post'],
},
Category: {
type: 'object',
properties: {
_id: { type: 'string' },
name: { type: 'string' },
description: { type: 'string' },
createdAt: { type: 'string', format: 'date-time' },
updatedAt: { type: 'string', format: 'date-time' },
},
required: ['name'],
},
},
securitySchemes: {
BearerAuth: {
type: 'http',
scheme: 'bearer',
bearerFormat: 'JWT',
},
},
},
};
const options = {
swaggerDefinition,
apis: ['./routes/*.js'],
};
const swaggerSpec = swaggerJSDoc(options);
module.exports = {
swaggerUi,
swaggerSpec,
};