Alterative route declaration

The only thing I don’t like about express-openapi is the “convention based programming”, I found very confusing and limiting.

I would prefer a simple javascript api doc with embedded handlers.

openapi.initialize({
    app: app,
    swagger: '2.0',
    basePath: '/v1',
    info: {
        title: 'App',
        version: '1.0.0',
    },
    paths: {
        '/users': {
            get: {
                parameters: [],
                responses: {
                    200: {
                        description: 'Get all users',
                        schema: {
                            type: 'array',
                            items: {
                                title: 'User',
                                type: 'object',
                                properties: {
                                    name: {
                                        type: 'string'
                                    }
                                }
                            },
                        }
                    }
                },
                handler(req, res) {
                    res.json([{name: 'Dale'}]);
                }
            },
            post: {
                handler(req, res) {
                    res.status(201);
                }
            }
        },
        '/users/{userId}': {
            get: {
                handler(req, res) {
                    res.json({name: 'Dale'});
                }
            }
        }
    }
});

You can use modules to split up the code, you have the full javascript language to generate routes or do whatever you like.

openapi.initialize({
    app: app,
    swagger: '2.0',
    basePath: '/v1',
    info: {
        title: 'App',
        version: '1.0.0',
    },
    paths: {
        '/users': require('./routes/users'),
        '/messages': {
            'get': require('./routes/messages').get
        },
        '/books': createCrudEndpoints("Books"),
        ...require('./lotsOfEndpointsUsingSpread')
    }
});

The existing convention based system could be used to build this structure internally.

[mika-fischer]

Yes, that also sounds fine, I’ll see if I can implement this this week.

[jsdevel]

Re-opening as express-openapi should aim to be as un-opinionated as possible to follow express’s purpose Fast, unopinionated, minimalist web framework for Node.js.