Unable to use scope together with docs

[oriontvv]

Hi, folk!
It looks like we can't use common preffix for a scope and default ui path swagger_ui_at("/-/docs").
For example, uncommenting lines will break docs:

App::new()
    .wrap_api()
    // .service(web::resource("/-/liveness").route(web::post().to(echo_pet)))
    // .service(
    //     web::scope("/-").service(web::resource("/metrics").route(web::post().to(echo_pet))),
    // )
    .with_json_spec_at("/api/spec/v2")
    .with_swagger_ui_at("/-/docs")
    .build()

[tiagolobocastro]

Hey!
By break the docs you mean the swagger endpoint is no longer available?

[oriontvv]

@tiagolobocastro Yep, swagger_ui's docs handler doesn't respond.

[tiagolobocastro]

I can't quite remember this properly but with actix when you define a scope (eg: for "/-"), unless you have guards (eg to check for a headers etc), you can't at a later stage stage add a handler for something that falls within "/-" outside of the scope? (which is what .with_swagger_ui_at("/-/docs") does)

[rlebran]

This is a known limitation of actix and this PR should fix the issue: actix/actix-web#2264

[lightsing]

you need to re-organize it as

App::new()
    .wrap_api()
    .with_json_spec_at("/api/spec/v2")
    .with_swagger_ui_at("/-/docs")
    .service(web::resource("/-/liveness").route(web::post().to(echo_pet)))
    .service(
       web::scope("/-").service(web::resource("/metrics").route(web::post().to(echo_pet))),
    )
    .build()

the scope router will swallow all traffic and return 404 if there's no match.
thus, you need to insert the route before scope