Extend openapi with support for .json and .yaml extension besides the current content negotiation mechanism

[sjaakd]

Description

The swagger documentation refers to a mechanism were .json and .yaml is used as extension on the openapi / swagger URL .

Other standards like this one, seem to extend upon that.

See also discussion in: #21457

Implementation ideas

Currently, I have implemented this as a vertx.RouteFilter. That does the trick. I've found this solution on other places, like this one. So I guess there's more demand for this feature.

    @RouteFilter
    public void modifyAcceptHeader(RoutingContext rc) {
        String url = rc.normalizedPath();
        if ( url.endsWith( "openapi.json" ) ) {
            String acceptHeader = rc.request().headers().get( ACCEPT );
            if ( acceptHeader != null && !acceptHeader.contains( "yaml" ) ) {
                rc.request().headers().set( ACCEPT, "application/json" );
            }
            rc.reroute(  url.substring( 0, url.lastIndexOf( '.' ) ) );
            return;
        }
        else if ( url.endsWith( "openapi.yaml" ) ) {
            rc.reroute(  url.substring( 0, url.lastIndexOf( '.' ) ) );
            return;
        }
        rc.next();
    }

[quarkus-bot]

/cc @EricWittmann, @MikeEdgar, @phillip-kruger

[phillip-kruger]

Thanks :)