akka/akka-http

Provide Segments path directive that matches 0 to n segments regardless of leading slashes

Open

#879 opened on Feb 20, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (1,311 stars) (598 forks)batch import
1 - triagedhelp wantedt:routing

Description

The existing Segments PathMatcher is mostly useful when trailing slashes are enforced everywhere. When no trailing slashes it is a bit more complicated right now to get a list of segments.

The implementation can be basically this:

def pathSegments: Directive1[List[String]] = (Slash ~ Segment).repeat(0, 128, PathMatchers.Neutral) ~ PathEnd // or PathEndOrSingleSlash?

It would allow to use

pathPrefix("tree") {
  pathSegments { segments =>
    ...
  }
}

which would match all of

  • /tree
  • /tree/abc
  • /tree/abc/def

but not

  • /tree/
  • /tree/abc/

/cc @lihaoyi

Contributor guide

Tech stack
scala
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Scala knowledgeAkka HTTP routing basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue proposes adding a `pathSegments` directive to Akka HTTP's PathMatcher. The contributor should examine the existing `Segments` PathMatcher implementation in the source code (likely in `akka http core/src/main/scala/akka/http/scaladsl/server/directives/PathDirectives.scala` or similar). The suggested implementation is `(Slash ~ Segment).repeat(0, 128, PathMatchers.Neutral) ~ PathEnd`. The contributor should verify the behavior with and without trailing slashes, and consider whether to use `PathEnd` or `PathEndOrSingleSlash`. Additionally, they should write tests and update documentation. Since the issue is old, it's advisable to check if the maintainers still want this feature or if there are any changes in the current codebase.