Skip to content

Commit 1ddc012

Browse files
Remove swagger-tools
1 parent f63a68b commit 1ddc012

File tree

4 files changed

+15
-34
lines changed

4 files changed

+15
-34
lines changed

example/app.js

+5-15
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
// Dependencies
55
var express = require('express');
66
var bodyParser = require('body-parser');
7-
var swaggerTools = require('swagger-tools');
87
var routes = require('./routes');
98
var swaggerJSDoc = require('../');
109

@@ -42,20 +41,11 @@ var options = {
4241
var swaggerSpec = swaggerJSDoc(options);
4342

4443

45-
// Swagger Tools Options
46-
var swaggerToolsUIOptions = {
47-
apiDocs: '/api-docs.json',
48-
swaggerUi: '/docs',
49-
};
50-
51-
52-
// Initialize the Swagger middleware
53-
swaggerTools.initializeMiddleware(swaggerSpec,
54-
function(middleware) {
55-
// Serve the Swagger documents and Swagger UI
56-
app.use(middleware.swaggerUi(swaggerToolsUIOptions));
57-
}
58-
);
44+
// Serve swagger docs the way you like (Recommendation: swagger-tools)
45+
app.get('/api-docs.json', function(req, res) {
46+
res.setHeader('Content-Type', 'application/json');
47+
res.send(swaggerSpec);
48+
});
5949

6050

6151
// Set up the routes

example/routes.js

+6-14
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,6 @@
11
'use strict';
22

33

4-
// Handler for the Homepage
5-
function rootHandler(req, res) {
6-
res.send('Hello World!');
7-
}
8-
9-
10-
// Handler for Login
11-
function loginHandler(req, res) {
12-
res.json(req.body);
13-
}
14-
15-
164
// Sets up the routes.
175
module.exports.setup = function(app) {
186

@@ -26,7 +14,9 @@ module.exports.setup = function(app) {
2614
* 200:
2715
* description: hello world
2816
*/
29-
app.get('/', rootHandler);
17+
app.get('/', function(req, res) {
18+
res.send('Hello World!');
19+
});
3020

3121

3222
/**
@@ -51,5 +41,7 @@ module.exports.setup = function(app) {
5141
* 200:
5242
* description: login
5343
*/
54-
app.post('/login', loginHandler);
44+
app.post('/login', function(req, res) {
45+
res.json(req.body);
46+
});
5547
};

external.jsdoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
*/
1616

1717
/**
18-
* Various tools for using and integrating with Swagger.
19-
* @external module:swagger-tools
18+
* Swagger JSON/YAML parser and validator for Node and browsers
19+
* @external module:swagger-parser
2020
* @global
21-
* @see https://www.npmjs.com/package/swagger-tools
21+
* @see https://www.npmjs.com/package/swagger-parser
2222
* @license MIT
2323
*/

package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@
3939
"mocha": "^2.2.5",
4040
"mocha-jscs": "^1.1.0",
4141
"mocha-jshint": "^2.2.3",
42-
"supertest": "^1.0.1",
43-
"swagger-tools": "^0.8.7"
42+
"supertest": "^1.0.1"
4443
}
4544
}

0 commit comments

Comments
 (0)