Giter Club home page Giter Club logo

express-joi-swagger's People

Contributors

cmmash avatar richardgirges avatar sikkapat79 avatar thenickot2 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

express-joi-swagger's Issues

Typescript support

This is a lovely library, for now I'm creating adhoc types since and it feels a little clunky.

Thanks

ExpressJoiSwagger.wrapRouter wrapped express app doesn't return http.Server

Say I initialize my swagger instance in a swaggers.js module as:

const swagger = new ExpressJoiSwagger({
  swaggerDefinition: {},
  ...
module.exports = swagger;

And then in my server file:

const swagger = require('./utils/swagger');
const app = express();

swaggerizedApp = swagger.wrapRouter(app);
const httpServer = swaggerizedApp.listen(SERVER_PORT, () => {
   console.log('swagger joi enabled server listening on ...');
});

But httpServer is undefined. I need it to pass it on to a Socket.IO server.
Is this a bug or am I doing something wrong?

Edit: Yup, found the issue: https://github.com/richardgirges/express-joi-swagger/blob/master/src/index.js#L129


  /**
   * Initiate express app.listen() and build the master swagger definition
   * @param {Object} expressRouter
   * @param {...any} args
   */
  _listen(expressRouter, ...args) {
    this._buildSwaggerDefinition(expressRouter);

    expressRouter.listen(...args); /* <<<<<<< PROBLEM */
  }

the express router listen call result isn't returned.

Swagger Reference JSON, for use in a separate UI

Hey, this is awesome, will be really cool if you get the: Serve out a Swagger UI automatically (currently only serves out the Swagger Reference JSON, for use in a separate UI).

Do you have any examples how to get the Swagger Reference JSON, for use in a separate UI?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.