buildo/metarpheus

Allow providing names for path params

Closed this issue · 0 comments

gabro commented

requirements

Currently the path params (e.g. Segment matchers in routes) are nameless

specs

As discussed offline with @utaal, we can parse a @pathParam doc annotation, matched by position.
Something along the lines of

pathPrefix("campings") {
  (get & path(IntNumber) & parameters('coolness.as[String], 'size.as[Int].?) /**
    get a camping by id

    @pathParam campingId the id of the camping

    @param coolness how cool it is
    @param size the number of tents
  */) (returns[Camping].ctrl(campingController.getById _))
}