object SwaggerUI
- Alphabetic
- By Inheritance
- SwaggerUI
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val DefaultSwaggerUIVersion: String
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def routes(path: PathCodec[Unit], version: String, api: OpenAPI, apis: OpenAPI*): Routes[Any, Response]
Creates a middleware for serving the Swagger UI at the given path and with the given swagger ui version.
Creates a middleware for serving the Swagger UI at the given path and with the given swagger ui version.
Example:
val routes: Routes[Any, Response] = ??? val openAPIv1: OpenAPI = ??? val openAPIv2: OpenAPI = ??? val swaggerUIRoutes = SwaggerUI.routes("docs" / "openapi", openAPIv1, openAPIv2) val routesWithSwagger = routes ++ swaggerUIRoutes
With this middleware in place, a request to
https://www.domain.com/[path]would serve the Swagger UI. The different OpenAPI specifications are served athttps://www.domain.com/[path]/[title].json. Wheretitleis the title of the OpenAPI specification and is url encoded. - def routes(path: PathCodec[Unit], api: OpenAPI, apis: OpenAPI*): Routes[Any, Response]
Creates routes for serving the Swagger UI at the given path.
Creates routes for serving the Swagger UI at the given path.
Example:
val routes: Routes[Any, Response] = ??? val openAPIv1: OpenAPI = ??? val openAPIv2: OpenAPI = ??? val swaggerUIRoutes = SwaggerUI.routes("docs" / "openapi", openAPIv1, openAPIv2) val routesWithSwagger = routes ++ swaggerUIRoutes
With this middleware in place, a request to
https://www.domain.com/[path]would serve the Swagger UI. The different OpenAPI specifications are served athttps://www.domain.com/[path]/[title].json. Wheretitleis the title of the OpenAPI specification and is url encoded. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])