package
swagger
Type Members
-
-
case class
Api(resourcePath: String, listingPath: Option[String], description: String, apis: List[Endpoint], models: Map[String, Model]) extends SwaggerApi[Endpoint] with Product with Serializable
-
case class
Endpoint(path: String, description: String, secured: Boolean = false, operations: List[Operation] = immutable.this.Nil) extends SwaggerEndpoint[Operation] with Product with Serializable
-
case class
Error(code: Int, reason: String) extends Product with Serializable
-
trait
JacksonSwaggerBase extends ScalatraSyntax with JacksonJsonSupport with CorsSupport with SwaggerBase
-
case class
Model(id: String, description: String, properties: Map[String, ModelField]) extends Product with Serializable
-
case class
ModelField(name: String, description: String, type: DataType, defaultValue: Option[String] = scala.None, enum: List[String] = immutable.this.Nil, required: Boolean = true) extends Product with Serializable
-
trait
NativeSwaggerBase extends ScalatraSyntax with NativeJsonSupport with CorsSupport with SwaggerBase
-
case class
Operation(httpMethod: HttpMethod, responseClass: String, summary: String, notes: Option[String] = scala.None, deprecated: Boolean = false, nickname: Option[String] = scala.None, parameters: List[Parameter] = immutable.this.Nil, errorResponses: List[Error] = immutable.this.Nil) extends SwaggerOperation with Product with Serializable
-
case class
Parameter(name: String, description: String, dataType: DataType, notes: Option[String] = scala.None, paramType: ParamType = ParamType.Query, defaultValue: Option[String] = scala.None, allowableValues: AllowableValues = AllowableValues.AnyValue, required: Boolean = true, allowMultiple: Boolean = false) extends Product with Serializable
-
-
-
-
-
-
-
-
-
-
trait
SwaggerSupportSyntax extends Initializable with CorsSupport
Value Members
-
-
object
Api extends Serializable
-
-
object
Model extends Serializable
-
object
ModelField extends Serializable
-
object
ParamType extends Enumeration
-
Inherited from AnyRef
Inherited from Any