diff --git a/swagger-jsdoc/swagger-jsdoc-tests.ts b/swagger-jsdoc/swagger-jsdoc-tests.ts new file mode 100644 index 0000000000..a3459a8fe0 --- /dev/null +++ b/swagger-jsdoc/swagger-jsdoc-tests.ts @@ -0,0 +1,24 @@ +/// +/// + +import * as express from 'express'; +import swaggerJSDoc = require('swagger-jsdoc'); +const app = express(); + +let options = { + swaggerDefinition: { + info: { + title: 'A test api', + version: '1.0.0' + } + } +}; + + +let swaggerSpec = swaggerJSDoc(options); + +app.get('/api-docs.json', function(req, res) { + res.send(swaggerSpec); +}) + +app.listen(8888); diff --git a/swagger-jsdoc/swagger-jsdoc-tests.ts.tscparams b/swagger-jsdoc/swagger-jsdoc-tests.ts.tscparams new file mode 100644 index 0000000000..30c9419a57 --- /dev/null +++ b/swagger-jsdoc/swagger-jsdoc-tests.ts.tscparams @@ -0,0 +1 @@ +-m commonjs diff --git a/swagger-jsdoc/swagger-jsdoc.d.ts b/swagger-jsdoc/swagger-jsdoc.d.ts new file mode 100644 index 0000000000..2181c35a03 --- /dev/null +++ b/swagger-jsdoc/swagger-jsdoc.d.ts @@ -0,0 +1,41 @@ +// Type definitions for Swagger-JSDoc +// Project: https://github.com/surnet/swagger-jsdoc +// Definitions by: Daniel Grove +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/* =================== USAGE =================== + + import * as express from "express" + import swaggerJSDoc = require('swagger-jsdoc'); + const app = express() + + let options = { + swaggerDefinition: { + info: { + title: 'Hello World', + version: '1.0.0', + description: 'A sample API' + }, + host: 'localhost:3000', + basePath: '/' + }, + apis: [ + './example/routes*.js', + './example/parameters.yaml' + ] + } + }; + + var spec = swaggerJSDoc(options); + + app.get('/api-docs.json', function(req, res) { + res.setHeader('Content-Type', 'application/json'); + res.send(spec); + }); + + =============================================== */ + +declare module "swagger-jsdoc" { + function swaggerJSDoc(options?: any): any; + export = swaggerJSDoc; +}