Skip to content

Commit 2eb165d

Browse files
committed
swagger
1 parent dad09a7 commit 2eb165d

File tree

6 files changed

+18
-14
lines changed

6 files changed

+18
-14
lines changed

readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![Build](https://img.shields.io/badge/build-passing-green.svg?style=flat-square)](http://tocausan.github.io)
2-
[![Build](https://img.shields.io/badge/version-0.2.1-D07183.svg?style=flat-square)](http://tocausan.github.io)
2+
[![Build](https://img.shields.io/badge/version-0.3.0-D07183.svg?style=flat-square)](http://tocausan.github.io)
33

44
# express-api-ts
55

src/app.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import * as bodyParser from 'body-parser';
88
import * as helmet from 'helmet';
99
import {Config} from './config';
1010
import {Routes} from './routes';
11-
import {Swagger} from "./routes/swagger";
1211

1312
const port = normalizePort(Config.api.port);
1413

@@ -18,7 +17,6 @@ const App = express()
1817
.use(bodyParser.urlencoded({extended: false}))
1918
.use(cookieParser())
2019
.set('port', port)
21-
.use('/', Swagger)
2220
.use('/', Routes)
2321
.use(helmet())
2422
.disable('x-powered-by');

src/routes/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import {Config} from '../config';
33
import {HeaderMiddleware, ValidationMiddleware} from '../middlewares';
44
import {ErrorController, AuthController, UserController, ProfileController} from '../controllers';
55
import {PopulationServices} from "../services";
6+
import Swagger from "./swagger";
67

78
const baseUrl = Config.api.path,
89
memberUrl = baseUrl + '/member',
@@ -12,6 +13,7 @@ const baseUrl = Config.api.path,
1213
if (process.env.ENV === 'dev') PopulationServices.default();
1314

1415
export const Routes = express.Router()
16+
.use('/', Swagger)
1517

1618
.all('/*', [HeaderMiddleware.enableCORS])
1719
.get('/', (req: express.Request, res: express.Response) => {

src/routes/swagger.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"swagger": "2.0",
33
"info": {
4-
"version": "0.1.0",
5-
"title": "webpack-express-typescript-swagger-api"
4+
"version": "0.3.0",
5+
"title": "express-api-ts"
66
},
77
"host": "localhost:3000",
88
"basePath": "/api/v1",
@@ -446,7 +446,7 @@
446446
"type": "string"
447447
},
448448
"language": {
449-
"type": "string"
449+
"type": "integer"
450450
},
451451
"role": {
452452
"type": "integer"

src/routes/swagger.ts

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
1-
import * as express from "express";
1+
import {Router} from "express";
22

33
const swaggerUi = require('swagger-ui-express'),
4-
swaggerDocument = require("./swagger.json"),
5-
swaggerJSDoc = require('swagger-jsdoc');
4+
swaggerDocument = require("./swagger.json");
65

7-
export const Swagger = express.Router()
8-
.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument))
6+
const Swagger = Router();
97

10-
.get('/swagger.json', (req, res) => {
8+
if (process.env.ENV === 'dev') {
9+
Swagger.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
10+
11+
Swagger.get('/swagger.json', (req, res) => {
1112
res.setHeader('Content-Type', 'application/json');
1213
res.send(JSON.stringify(swaggerDocument, null, 2));
13-
});
14+
});
15+
}
16+
17+
export default Swagger;

src/services/user.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export const UserServices = {
4444

4545
updateUser: async (username: string, update: any): Promise<User> => {
4646
const user: User = await UserServices.getUser(username);
47-
return new User(await (DbClient.findOneAndUpdate(Config.database.collections.users, {_id: user.id}, update)))
47+
return await (DbClient.findOneAndUpdate(Config.database.collections.users, {_id: user.id}, update));
4848
},
4949

5050
deleteUser: async (username: string): Promise<void> => {

0 commit comments

Comments
 (0)