SwaggerSpecGenerator

Instance Constructors

new SwaggerSpecGenerator(namingStrategy: NamingStrategy = NamingStrategy.None, modelQualifier: DomainModelQualifier = PrefixDomainModelQualifier(), defaultPostBodyFormat: String = "application/json", outputTransformers: Seq[OutputTransformer] = Nil, swaggerV3: Boolean = false, swaggerPlayJava: Boolean = false, apiVersion: Option[String] = None)(implicit cl: ClassLoader)

Type Members

implicit class PathAdditions extends AnyRef
type Routes = (String, Seq[Route])
type RoutesData = Try[ListMap[Tag, Routes]]

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 apiVersion: Option[String]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
val defaultPostBodyFormat: String
val defaultRoutesFile: String
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def generate(routesFile: String = defaultRoutesFile): Try[JsObject]
def generateFromRoutes(routes: ListMap[Tag, (String, Seq[Route])], base: JsObject = defaultBase): JsObject

Generate directly from routes
Generate directly from routes
routes
Routes compiled by Play routes compiler
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val modelQualifier: DomainModelQualifier
val namingStrategy: NamingStrategy
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
val outputTransformers: Seq[OutputTransformer]
val routesExt: String
val swaggerPlayJava: Boolean
val swaggerV3: Boolean
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Docs: object SwaggerSpecGenerator | package playSwagger

Instance Constructors

Type Members

implicit class PathAdditions extends AnyRef

type Routes = (String, Seq[Route])

type RoutesData = Try[ListMap[Tag, Routes]]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val apiVersion: Option[String]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val defaultPostBodyFormat: String

val defaultRoutesFile: String

final def eq(arg0: AnyRef): Boolean

def generate(routesFile: String = defaultRoutesFile): Try[JsObject]

def generateFromRoutes(routes: ListMap[Tag, (String, Seq[Route])], base: JsObject = defaultBase): JsObject

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val modelQualifier: DomainModelQualifier

val namingStrategy: NamingStrategy

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val outputTransformers: Seq[OutputTransformer]

val routesExt: String

val swaggerPlayJava: Boolean

val swaggerV3: Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped