JKHeadley / rest-hapi

🚀 A RESTful API generator for Node.js
https://resthapi.com
MIT License
1.19k stars 153 forks source link

Custom header option to swagger ui for all routes #189

Open sumitsaha opened 5 years ago

sumitsaha commented 5 years ago

According to documentation it's possible to pass a header parameter to a specific route by passing a validate function to route config object like this:

server.route({
    method: 'PUT',
    path: '/generate',
    config: {
        validate: {
            headers: Joi.object({
                my_custom_header: Joi.string().required()
            }).options({
                allowUnknown: true
            })
        }
    }
});

But this would add a header option to swagger ui only for the route "/generate" like this image:

Screen Shot 2019-08-15 at 1 39 02 AM

I want to to add a common header option to all routes in swagger ui in my hapi server. Is it possible? Please note that I have already used the securityDefinitions to set a api_key. What I want is another common header values to swagger ui.

JKHeadley commented 5 years ago

Hi @sumitsaha . I'm not quite sure, but this sounds more like a hapi or hapi-swagger question rather than rest-hapi. Are you trying to do this with the routes generated by rest-hapi?