swagger

Type Members

1. trait AllowableValues extends AnyRef

2. case class Api(resourcePath: String, listingPath: Option[String], description: String, apis: List[Endpoint], models: Map[String, Model]) extends SwaggerApi[Endpoint] with Product with Serializable

3. case class Endpoint(path: String, description: String, secured: Boolean = false, operations: List[Operation] = immutable.this.Nil) extends SwaggerEndpoint[Operation] with Product with Serializable

4. case class Error(code: Int, reason: String) extends Product with Serializable

5. trait JacksonSwaggerBase extends ScalatraBase with JacksonJsonSupport with CorsSupport with SwaggerBase

6. case class Model(id: String, description: String, properties: Map[String, ModelField]) extends Product with Serializable

7. case class ModelField(name: String, description: String, type: DataType, defaultValue: Option[String] = scala.None, required: Boolean = true) extends Product with Serializable

8. trait NativeSwaggerBase extends ScalatraBase with NativeJsonSupport with CorsSupport with SwaggerBase

9. 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

10. 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

11. class Swagger extends SwaggerEngine[Api]

    An instance of this class is used to hold the API documentation.

12. trait SwaggerApi[T <: SwaggerEndpoint[_]] extends AnyRef

13. trait SwaggerBase extends SwaggerBaseBase

14. trait SwaggerBaseBase extends Initializable with ScalatraBase

    Trait that serves the resource and operation listings, as specified by the Swagger specification.

15. trait SwaggerEndpoint[T <: SwaggerOperation] extends AnyRef

16. trait SwaggerEngine[T <: SwaggerApi[_]] extends AnyRef

17. trait SwaggerOperation extends AnyRef

18. trait SwaggerSupport extends ScalatraBase with SwaggerSupportBase with SwaggerSupportSyntax

    Provides the necessary support for adding documentation to your routes.

19. trait SwaggerSupportBase extends AnyRef

20. trait SwaggerSupportSyntax extends Initializable with CorsSupport