[Improvement]: Support for HTTP resources with trailing slashes

[slahirucd7]

Description

Considere a scenario where there are two HTTP resources as /abc and /abc/
In ballerina those two resources are considering as the same.
But in other languages those are considered as two different resources.

Describe your problem(s)

import ballerina/http;


service on new http:Listener(9092) {

    resource function get rsc() returns string {
        return "without trailing slash";
    }

    resource function get rsc\/() returns string {
        return "with trailing slash";
    }
    resource function get rsc/[string a]() returns string {
        return "with trailing slash and path param " + a;
    }
    // This is not allowed to have in ballerina
    // resource function get rsc/[string a]\/() returns string {
    //     return "with trailing slash and path param" + a;
    // }
}

Describe your solution(s)

Provide the support to consider resource with trailing slash as a separate API resource.

Related area

-> Compilation

Related issue(s) (optional)

No response

Suggested label(s) (optional)

No response

Suggested assignee(s) (optional)

No response

[TharmiganK]

Here the actual requirement is to differentiate the business logic in two different resources for requests coming in paths /abc and /abc/. Even though it is not recommended to have both resources, other languages like spring boot support this.

service /api on new http:Listener(9090) {

    resource function get abc() returns http:Response {
        // Logic for requests with path `/api/abc`
    }

    resource function get abc/() returns http:Response {
        // Logic for requests with path `/api/abc/`
    }
}

This is not supported in Ballerina since the Ballerina specifications does not allow trailing slashes in path segment. The slash should be followed by either a path-segment or a path-rest-parameter.

So to support this, we should have a single resource and then access the raw path to execute the logic

service /api on new http:Listener(9090) {

    resource function get abc(http:Request req) returns http:Response {
        string rawPath = req.rawPath;
        if rawPath.endsWith("/") {
            // Logic for requests with path `/api/abc/`
        } else {
            // Logic for requests with path `/api/abc`
        }
    }
}

Adding @MaryamZi and @shafreenAnfar for their insights

[MaryamZi]

There is an open spec issue related to this - ballerina-platform/ballerina-spec#677

[MaryamZi]

Closing this since there is an open spec issue to track this.