Hi @Daenyth
As an alternative to
You can see an example here https://github.com/http4s/rho/blob/master/examples/src/main/scala/com/http4s/rho/swagger/demo/MyRoutes.scala#L45
As an alternative to
'foo we've introduced pv"foo". pv stands for pathVar.You can see an example here https://github.com/http4s/rho/blob/master/examples/src/main/scala/com/http4s/rho/swagger/demo/MyRoutes.scala#L45
is there any convenient way to use a different logger (scalalogging's one) but still using the variable name
logger ?
Hi @Yotamho
You cloud copy the source of RhoRoutes, and have your own version with the logger field removed. That's what I would do.
Among other options you can also create a block { } inside your class extending RhoRoutes. And while you cannot create a 'logger' field in the class, you can create a val logger in the block, which will shadow the logger field inherited from RhoRoutes. You would then have to put all your code using the logger inside that block. That would work as long as you don't plan having any public members in that class (you can't put public members in the block). It's a bit hacky :P
- in: "body"
name: "body"
description: "List«Long»"
required: true
schema:
type: "array"
items:
title: "Long"
$ref: "#/definitions/Long"
are you sure you're generating utf-8 yaml and viewing the file as utf-8
I think that specific character indicates your yaml file might actually be Latin-1 instead of utf-8
If not that, then the inverse
Or CP1252, which is almost the same as Latin-1
in the doc it makes a list of empty object
I would have thought it should make items with: type: 'Integer', no ref as it's a primitive and then format: 'int64'
like this
type: "array"
items:
type: "integer"
format: "int64"
generics must take subtypes of
Object (AnyRef), which primitives are not
yeah - I'm not sure how frequently things get picked up here - maybe I should take a look and send a pull request
thanks for your help :)
@Daenyth do you know if it's possible to write the generated yaml / json to a file as well as serving it? Currently the served yaml inherits the authorisation so can't be accessed unless authorised but we want to maybe write it to file and serve it from a non authed endpoint.
Hey all, quick (and potentially naive) question about using the API. After some digging as to why my swagger docs didn't cover any of the response types, I discovered that if I moved the response code (e.g.
Ok(...)) into the body of new RhoRoutes[IO] { ... } then everything started working. So my next question is, how can we achieve this without requiring that everything be written in situ?
At the moment, my best guess is to pass new argument around everywhere
(implicit responses: ResponseGeneratorInstances[IO]) and try and use this when declaring the routes? ... E.g. "Description of an endpoint" **
POST / "pathhere" ^ jsonOf[IO,MyType] |>> {
(body: MyType) => myDef(body)(this)
}
I feel like this can't possibly be the right way to go about it though
Ive just started using rho and i found that due to the way it works with implicits i have to put everyhing inside the new RhoRoutes - the only way i found as a workaround was to pass the rho routes into another class and import e.g. import rhoRoutes._ to get all the implicits
Hi. I have an API using authorization on some end points. I'm trying to integrate rho for swagger generation. Above I found a message that confirmed that for generating swagger spec, there is some plumbing required for APIs with authorization (cannot use SwaggerMiddleware). But I have even more problems (at least I think so, because I do not fully grasp everything). My authorized routes are nested within Routers. I'm under the impression that the authorization rho meta information does not compose through Routers. At least this is not implemented. Can someone please comment on my thoughts? I can also provide some more details, if required.
Hi All, could anyone point me in the right direction as to how I can specify the swagger format for a query param. I currently have a query parameter that I would like to be displayed as a
UUID. I tried to have a look at the lib code but couldn't find any references to format
On another note. I have defined some query parameters and custom query parsers. Howver i noticed that the swagger docs dont show the error responses that can be returned as a result of those query parsers failing. Is there a way to enforce this?
Hey there, having some trouble with Refined types. I saw that someone had posted an issue on it. They mentioned that adding their own StringParser solved their issues. I have done the same but cannot find a solution. My case class that used refined types doesn't have a successful definition in the Swagger UI.
Even after adding a custom StringParser.
Hello! I am brand new to using rho. I have an existing http4s application that under certain error conditions returns status code 470 or 471. These are custom codes that have particular business meaning. I don't understand how to write the rho DSL that will allow custom response codes. It seems like the type structure of
Result locks you into only the "common" status codes.
Hello smart people!
Could anyone explain to me how i can generalize my authentication response?
I wrote this, and used in in a route. It works, but the swagger field for the
Could anyone explain to me how i can generalize my authentication response?
I wrote this, and used in in a route. It works, but the swagger field for the
responses part is not generated at all.def doOrAccessDenied(user: Option[UserInfo], w: => F[Result.BaseResult[F]])(
implicit F: Monad[F],
): F[Result.BaseResult[F]] = {
user match {
case Some(user) if user.canWrite => w
case Some(_) => Forbidden(Error.forbidden)
case None => Unauthorized(Error.unauthorized)
}
}