Packages

t

com.github.swagger.akka

SwaggerGenerator

trait SwaggerGenerator extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
SwaggerHttpService
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SwaggerGenerator
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apiClasses: Set[Class[_]]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apiDocsPath: String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def basePath: String
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def components: Option[Components]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def externalDocs: Option[ExternalDocumentation]
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. def generateSwaggerJson: String
  14. def generateSwaggerYaml: String
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def host: String

    returns

    the host (and possibly, port) for the API (eg api.example.com or localhost:8080)

    • used in conjunction with the schemes - this is ignored if you have non-empty serverURLs
  18. def info: Info
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def reader: Reader
  24. def schemes: List[String]

    returns

    list of URL schemes (default is ["http"]) - this is ignored if you have non-empty serverURLs

  25. def security: List[SecurityRequirement]
  26. def securitySchemes: Map[String, SecurityScheme]
  27. def serverURLs: Seq[String]

    returns

    list of URLs (as strings) - if this list is empty, then the values are derived using the SwaggerGenerator.host and schemes

  28. def specVersion: SpecVersion
  29. def swaggerConfig: OpenAPI
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def unwantedDefinitions: Seq[String]
  33. def vendorExtensions: Map[String, AnyRef]
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped