diff --git a/example/app.js b/example/app.js index 4109619c..e9e5bc01 100644 --- a/example/app.js +++ b/example/app.js @@ -4,7 +4,7 @@ var cookieParser = require('cookie-parser'); var bodyParser = require('body-parser'); var logger = require('morgan'); var http = require('http'); -var OpenApiMiddleware = require('../').OpenApiMiddleware; +var OpenApiMiddleware = require('express-middleware-openapi').OpenApiMiddleware; var app = express(); app.use(bodyParser.json()); @@ -15,7 +15,7 @@ app.use(cookieParser()); app.use(express.static(path.join(__dirname, 'public'))); new OpenApiMiddleware({ - apiSpecPath: './openapi.yaml', + apiSpecPath: '../openapi.yaml', validateApiDoc: true, // the default enableObjectCoercion: true, // the default }).install(app); @@ -37,6 +37,14 @@ app.get('/v1/pets/:id', function(req, res, next) { }); }); +app.get('/v1/pets/:id/attributes', function(req, res, next) { + res.json({ + id: req.params.id, + name: 'sparky', + }); +}); + + var server = http.createServer(app); server.listen(3000); console.log('Listening on port 3000'); diff --git a/example/openapi.yaml b/example/openapi.yaml deleted file mode 100644 index a72f7be4..00000000 --- a/example/openapi.yaml +++ /dev/null @@ -1,165 +0,0 @@ -openapi: "3.0.0" -info: - version: 1.0.0 - title: Swagger Petstore - description: A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification - termsOfService: http://swagger.io/terms/ - contact: - name: Swagger API Team - email: apiteam@swagger.io - url: http://swagger.io - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html -servers: - - url: http://petstore.swagger.io/v1 -paths: - /pets: - get: - description: | - Returns all pets from the system that the user has access to - Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia. - - Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien. - operationId: findPets - parameters: - - name: tags - in: query - description: tags to filter by - required: false - style: form - schema: - type: array - items: - type: string - - name: limit - in: query - description: maximum number of results to return - required: true - schema: - type: integer - format: int32 - minimum: 5 - - name: test - in: query - description: maximum number of results to return - required: true - schema: - type: string - enum: - - one - - two - responses: - "200": - description: pet response - content: - application/json: - schema: - type: array - items: - $ref: "#/components/schemas/Pet" - default: - description: unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - post: - description: Creates a new pet in the store. Duplicates are allowed - operationId: addPet - requestBody: - description: Pet to add to the store - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/NewPet" - responses: - "200": - description: pet response - content: - application/json: - schema: - $ref: "#/components/schemas/Pet" - default: - description: unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - /pets/{id}: - get: - description: Returns a user based on a single ID, if the user does not have access to the pet - operationId: find pet by id - parameters: - - name: id - in: path - description: ID of pet to fetch - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: pet response - content: - application/json: - schema: - $ref: "#/components/schemas/Pet" - default: - description: unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - delete: - description: deletes a single pet based on the ID supplied - operationId: deletePet - parameters: - - name: id - in: path - description: ID of pet to delete - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: pet deleted - default: - description: unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" -components: - schemas: - NewPet: - required: - - name - properties: - name: - type: string - tag: - type: string - - Pet: - allOf: - - $ref: "#/components/schemas/NewPet" - - required: - - id - properties: - id: - type: integer - format: int64 - - Error: - required: - - code - - message - properties: - code: - type: integer - format: int32 - message: - type: string diff --git a/example/package-lock.json b/example/package-lock.json index 3224b5cf..f9d0a1c8 100644 --- a/example/package-lock.json +++ b/example/package-lock.json @@ -13,6 +13,25 @@ "negotiator": "0.6.1" } }, + "ajv": { + "version": "6.10.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.10.0.tgz", + "integrity": "sha512-nffhOpkymDECQyR0mnsUtoCE8RlX38G0rYP+wgLWFyZuUyuuojSSvi/+euOiQBIn63whYwYVIIH1TvE3tu4OEg==", + "requires": { + "fast-deep-equal": "^2.0.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + } + }, + "argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "requires": { + "sprintf-js": "~1.0.2" + } + }, "array-flatten": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", @@ -110,6 +129,11 @@ "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", "integrity": "sha1-Aljq5NPQwJdN4cFpGI7wBR0dGYg=" }, + "esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==" + }, "etag": { "version": "1.8.1", "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", @@ -155,17 +179,26 @@ "express-middleware-openapi": { "version": "file:..", "requires": { - "body-parser": "^1.18.3", - "cookie-parser": "^1.4.4", - "express": "^4.16.4", - "express-normalize-query-params-middleware": "^0.5.0", "js-yaml": "^3.12.2", - "morgan": "^1.9.1", - "openapi-framework": "^0.22.0", + "lodash": "^4.17.11", + "openapi-request-coercer": "^2.3.0", + "openapi-request-validator": "^3.7.0", "openapi-schema-validator": "^3.0.3", - "openapi-types": "1.3.4" + "openapi-security-handler": "^2.0.4", + "openapi-types": "1.3.4", + "ts-log": "^2.1.4" } }, + "fast-deep-equal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz", + "integrity": "sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk=" + }, + "fast-json-stable-stringify": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz", + "integrity": "sha1-1RQsDK7msRifh9OnYREGT4bIu/I=" + }, "finalhandler": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.1.1.tgz", @@ -219,6 +252,30 @@ "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.8.0.tgz", "integrity": "sha1-6qM9bd16zo9/b+DJygRA5wZzix4=" }, + "js-yaml": { + "version": "3.13.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.0.tgz", + "integrity": "sha512-pZZoSxcCYco+DIKBTimr67J6Hy+EYGZDY/HCWC+iAEA9h1ByhMXAIVUXMcMFpOCxQ/xjXmPI2MkDL5HRm5eFrQ==", + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + }, + "json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + }, + "lodash": { + "version": "4.17.11", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.11.tgz", + "integrity": "sha512-cQKh8igo5QUhZ7lg38DYWAxMvjSAKG0A8wGSVimP07SIUEK2UO+arSRKbRZWtelMtN5V0Hkwh5ryOto/SshYIg==" + }, + "lodash.merge": { + "version": "4.6.1", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.1.tgz", + "integrity": "sha512-AOYza4+Hf5z1/0Hztxpm2/xiPZgi/cjMqdnKTUWTBSKchJlxXXuUSxCCl8rJlf4g6yww/j6mA8nC8Hw/EZWxKQ==" + }, "media-typer": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", @@ -287,6 +344,57 @@ "resolved": "https://registry.npmjs.org/on-headers/-/on-headers-1.0.2.tgz", "integrity": "sha512-pZAE+FJLoyITytdqK0U5s+FIpjN0JP3OzFi/u8Rx+EV5/W+JTWGXG8xFzevE7AjBfDqHv/8vL8qQsIhHnqRkrA==" }, + "openapi-jsonschema-parameters": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/openapi-jsonschema-parameters/-/openapi-jsonschema-parameters-1.1.1.tgz", + "integrity": "sha512-KYcDHQP3Yno8H3pwJzLVvEJ7MAcrBsMzZSFzpyWFz96CqwgHGX+Suj6UbqajpO/LK4owAcal543JR7cMV+eDRw==", + "requires": { + "openapi-types": "1.3.4" + } + }, + "openapi-request-coercer": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/openapi-request-coercer/-/openapi-request-coercer-2.3.0.tgz", + "integrity": "sha512-oLrxgYOS3CE+ystqeZEBlpxiuQy6Q5HNLMLj9ciMGdJL7x73NedVWkEU00RJ8acjqZJEm73IYMRhQ0D4De14/A==", + "requires": { + "openapi-types": "1.3.4" + } + }, + "openapi-request-validator": { + "version": "3.7.0", + "resolved": "https://registry.npmjs.org/openapi-request-validator/-/openapi-request-validator-3.7.0.tgz", + "integrity": "sha512-Cx/mfwd/F979LNHk1qMDJ+TU8BgzkvUZ6rLkJlmQy5f+yUAnIOT1lFBoml168fKufINX9uDqScTcOOdxGNjTkg==", + "requires": { + "ajv": "^6.5.4", + "content-type": "^1.0.4", + "openapi-jsonschema-parameters": "1.1.1", + "openapi-types": "1.3.4" + } + }, + "openapi-schema-validator": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/openapi-schema-validator/-/openapi-schema-validator-3.0.3.tgz", + "integrity": "sha512-KKpeNEvAmpy6B2JCfyrM4yWjL6vggDCVbBoR8Yfkj0Jltc6PCW+dBbcg+1yrTCuDv80qBQJ6w0ejA71DlOFegA==", + "requires": { + "ajv": "^6.5.2", + "lodash.merge": "^4.6.1", + "openapi-types": "1.3.4", + "swagger-schema-official": "2.0.0-bab6bed" + } + }, + "openapi-security-handler": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/openapi-security-handler/-/openapi-security-handler-2.0.4.tgz", + "integrity": "sha512-blz/UftEqYQLAByuEVITePUI9hV5Rd91CEK8yrsKDUaf3zk6cmIMafJ2qvagHqjXRRtL7fOqvsSKIeFrai+HfQ==", + "requires": { + "openapi-types": "1.3.4" + } + }, + "openapi-types": { + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-1.3.4.tgz", + "integrity": "sha512-h8rADpW3k/wepLdERKF0VKMAPdoFYNQCLGPmc/f8sgQ2dxUy+7sY4WAX2XDUDjhKTjbJVbxxofLkzy7f1/tE4g==" + }, "parseurl": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.2.tgz", @@ -306,6 +414,11 @@ "ipaddr.js": "1.8.0" } }, + "punycode": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==" + }, "qs": { "version": "6.5.2", "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz", @@ -373,11 +486,26 @@ "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.0.tgz", "integrity": "sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ==" }, + "sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=" + }, "statuses": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.4.0.tgz", "integrity": "sha512-zhSCtt8v2NDrRlPQpCNtw/heZLtfUDqxBM1udqikb/Hbk52LK4nQSwr10u77iopCW5LsyHpuXS0GnEc48mLeew==" }, + "swagger-schema-official": { + "version": "2.0.0-bab6bed", + "resolved": "https://registry.npmjs.org/swagger-schema-official/-/swagger-schema-official-2.0.0-bab6bed.tgz", + "integrity": "sha1-cAcEaNbSl3ylI3suUZyn0Gouo/0=" + }, + "ts-log": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/ts-log/-/ts-log-2.1.4.tgz", + "integrity": "sha512-P1EJSoyV+N3bR/IWFeAqXzKPZwHpnLY6j7j58mAvewHRipo+BQM2Y1f9Y9BjEQznKwgqqZm7H8iuixmssU7tYQ==" + }, "type-is": { "version": "1.6.16", "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.16.tgz", @@ -392,6 +520,14 @@ "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=" }, + "uri-js": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.2.2.tgz", + "integrity": "sha512-KY9Frmirql91X2Qgjry0Wd4Y+YTdrdZheS8TFwvkbLWf/G5KNJDCh6pKL5OZctEW4+0Baa5idK2ZQuELRwPznQ==", + "requires": { + "punycode": "^2.1.0" + } + }, "utils-merge": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", diff --git a/example/package.json b/example/package.json index d9e48843..07b78024 100644 --- a/example/package.json +++ b/example/package.json @@ -4,6 +4,7 @@ "description": "", "main": "index.js", "scripts": { + "start": "node app.js", "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], diff --git a/package.json b/package.json index 34e6c9c6..e9f1ad8b 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "main": "dist/index.js", "scripts": { "compile": "rm -rf dist/ && tsc", - "test": "nyc --reporter=text --reporter=lcov mocha -r source-map-support/register -r ts-node/register --recursive test/**/*.spec.ts", + "test": "nyc --reporter=text --reporter=lcov mocha -r source-map-support/register -r ts-node/register --recursive test/**/*.spec.ts --exit", "coveralls": "cat ./coverage/lcov.info | coveralls -v" }, "keywords": [], diff --git a/test/app.common.ts b/test/app.common.ts new file mode 100644 index 00000000..675e2942 --- /dev/null +++ b/test/app.common.ts @@ -0,0 +1,38 @@ +export function startServer(app, port) { + const http = require('http'); + const server = http.createServer(app); + server.listen(port); + console.log(`Listening on port ${port}`); + return app; +} + +export function routes(app) { + app.get('/v1/pets', function(req, res, next) { + console.log('at /v1/pets here'); + res.json({ + test: 'hi', + }); + }); + + app.post('/v1/pets', function(req, res, next) { + res.json({ + test: 'hi', + }); + }); + + app.get('/v1/pets/:id', function(req, res, next) { + console.log('---- get /pets/:id', req.params); + // here + res.json({ + id: req.params.id, + }); + }); + + app.get('/v1/pets/:id/attributes', function(req, res, next) { + console.log('---- get /pets/:id', req.params); + // here + res.json({ + id: req.params.id, + }); + }); +} diff --git a/test/app.ts b/test/app.ts index 63850a0e..12266cec 100644 --- a/test/app.ts +++ b/test/app.ts @@ -3,8 +3,9 @@ var path = require('path'); var cookieParser = require('cookie-parser'); var bodyParser = require('body-parser'); var logger = require('morgan'); -const http = require('http'); + const { OpenApiMiddleware } = require('../'); +const { startServer, routes } = require('./app.common'); var app = express(); @@ -13,7 +14,6 @@ app.use(logger('dev')); app.use(express.json()); app.use(express.urlencoded({ extended: false })); app.use(cookieParser()); - app.use(express.static(path.join(__dirname, 'public'))); new OpenApiMiddleware({ @@ -27,37 +27,8 @@ new OpenApiMiddleware({ }, }).install(app); -app.get('/v1/pets', function(req, res, next) { - console.log('at /v1/pets here'); - res.json({ - test: 'hi', - }); -}); - -app.post('/v1/pets', function(req, res, next) { - res.json({ - test: 'hi', - }); -}); - -app.get('/v1/vets/:id', function(req, res, next) { - console.log('---- get /pets/:id', req.params); - // here - res.json({ - id: req.params.id, - }); -}); - -app.get('/v1/pets/:id', function(req, res, next) { - console.log('---- get /pets/:id', req.params); - // here - res.json({ - id: req.params.id, - }); -}); - -export const server = http.createServer(app); -server.listen(3000); -console.log('Listening on port 3000'); +routes(app); + +startServer(app, 3000); export default app; diff --git a/test/app.with.transform.ts b/test/app.with.transform.ts index 7c29c64c..f6773966 100644 --- a/test/app.with.transform.ts +++ b/test/app.with.transform.ts @@ -3,8 +3,9 @@ var path = require('path'); var cookieParser = require('cookie-parser'); var bodyParser = require('body-parser'); var logger = require('morgan'); -const http = require('http'); + const { OpenApiMiddleware } = require('../'); +const { startServer, routes } = require('./app.common'); var app = express(); @@ -31,38 +32,8 @@ new OpenApiMiddleware({ }, }).install(app); -app.get('/v1/pets', function(req, res, next) { - console.log('at /v1/pets here'); - res.json({ - test: 'hi', - }); -}); - -app.post('/v1/pets', function(req, res, next) { - res.json({ - test: 'hi', - }); -}); - -app.get('/v1/vets/:id', function(req, res, next) { - console.log('---- get /pets/:id', req.params); - // here - res.json({ - id: req.params.id, - }); -}); - -app.get('/v1/pets/:id', function(req, res, next) { - console.log('---- get /pets/:id', req.params); - // here - res.json({ - id: req.params.id, - }); -}); +routes(app); -export const server = http.createServer(app); -const port = 3001; -server.listen(port); -console.log(`Listening on port ${port}`); +startServer(app, 3001); export default app; diff --git a/test/error.transform.spec.ts b/test/error.transform.spec.ts index bced5a90..e3f246b2 100644 --- a/test/error.transform.spec.ts +++ b/test/error.transform.spec.ts @@ -1,16 +1,8 @@ const expect = require('chai').expect; import * as request from 'supertest'; -import app, { server } from './app.with.transform'; -import { server as server2 } from './app'; +import app from './app.with.transform'; describe('custom error transform', () => { - after(done => { - console.log('done', app); - server.close(); - server2.close(); - done(); - }); - it('should transform the error output', async () => { const id = 'my_id'; return request(app) diff --git a/test/routes.spec.ts b/test/routes.spec.ts index ea57b45d..e150a194 100644 --- a/test/routes.spec.ts +++ b/test/routes.spec.ts @@ -1,17 +1,10 @@ const expect = require('chai').expect; import * as request from 'supertest'; -import app, { server } from './app'; -import { server as server2 } from './app.with.transform'; +import app from './app'; const packageJson = require('../package.json'); describe(packageJson.name, () => { - after(done => { - console.log('done', app); - server.close(); - server2.close(); - done(); - }); it(`should test something`, () => { expect('a').to.equal('a'); }); diff --git a/tsconfig.json b/tsconfig.json index ac382d37..b3efff27 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -2,9 +2,10 @@ "compilerOptions": { "declaration": true, "lib": ["es6", "dom"], - "module": "CommonJS", + "module": "commonjs", "outDir": "dist", "sourceMap": true }, - "files": ["index.ts"] + "exclude": ["node_modules"], + "include": ["typings.d.ts", "index.ts", "fw/**/*.ts", "errors/**/*.ts"] }