akka/akka-http

Path matcher DSL docs for Java API

Open

#1,650 opened on Dec 18, 2017

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

Description

docs/src/main/paradox/scala/http/routing-dsl/path-matchers.md contains an introduction for both Scala and Java, but is way more detailed for the Scala API. It would be great if someone could add similar details and examples for the Java API!

Contributor guide

Tech stack
javascala
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
Basic knowledge of JavaFamiliarity with Akka HTTP route DSL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests enhancing the Java API documentation in the file "docs/src/main/paradox/scala/http/routing dsl/path matchers.md". Start by reviewing the existing Scala examples in that file to understand the format and level of detail. Then, refer to the Akka HTTP Java API documentation and source code to identify equivalent Java constructs for path matchers. Add similarly structured examples for the Java API, ensuring consistency with the Scala documentation style. The file is in a Scala based project, so changes should be made in the same file but with clear Java code blocks.
Path matcher DSL docs for Java API · akka/akka-http#1650 | Good First Issue