SwaggerChecks

Instance Constructors

new SwaggerChecks(swaggerAPI: SwaggerAPI, stringFormats: Map[String, GeneratableFormat[String]] = StringFormats.defaultFormats, integerFormats: Map[String, GeneratableFormat[BigInt]] = IntegerFormats.defaultFormats, numberFormats: Map[String, GeneratableFormat[BigDecimal]] = NumberFormats.defaultFormats, maxItems: Int = 10)

swaggerAPI
the swagger API
stringFormats
map of all string formats
integerFormats
map of all integer formats
numberFormats
map of all number formats
maxItems
default maximum number of items in arrays (or objects with additionalProperties) might be overriden be minItems or maxItems in swagger file

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
def arbitraryArray: Gen[CheckJsValue]

Definition Classes
GeneratableSchema
def arbitraryObj: Gen[CheckJsValue]

Definition Classes
GeneratableSchema
def arbitraryProperty: Gen[(String, CheckJsValue)]

Definition Classes
GeneratableSchema
def arbitraryValue: Gen[CheckJsValue]

Definition Classes
GeneratableSchema
final def asInstanceOf[T0]: T0

Definition Classes
Any
def childContext: SwaggerChecks

Create a child context with reduced maxItems.
Create a child context with reduced maxItems.
Mostly used internally to ensure that size of arrays decay with depth.

Definition Classes
SwaggerChecks → GeneratableSchema
def clone(): AnyRef

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

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def findByRef(ref: String): Option[Definition]

Definition Classes
SwaggerChecks → Schema
def findGeneratableIntegerFormat(format: String): Option[GeneratableFormat[BigInt]]

Definition Classes
SwaggerChecks → GeneratableSchema
def findGeneratableNumberFormat(format: String): Option[GeneratableFormat[BigDecimal]]

Definition Classes
SwaggerChecks → GeneratableSchema
def findGeneratableStringFormat(format: String): Option[GeneratableFormat[String]]

Definition Classes
SwaggerChecks → GeneratableSchema
def findIntegerFormat(name: String): Option[ValueFormat[BigInt]]

Definition Classes
GeneratableSchema → Schema
def findNumberFormat(name: String): Option[ValueFormat[BigDecimal]]

Definition Classes
GeneratableSchema → Schema
def findStringFormat(name: String): Option[ValueFormat[String]]

Definition Classes
GeneratableSchema → Schema
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val integerFormats: Map[String, GeneratableFormat[BigInt]]

map of all integer formats
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def jsonGenerator(name: String): Gen[CheckJsValue]

Create a generator for random json based on a swagger definition.
Create a generator for random json based on a swagger definition.
Usually you want to use this to ensure that all your deserializers are working.
name
name of the swagger definition
returns
generator for json
def jsonVerifier(name: String): Validator[String]

Get a verifier that verifies, if a string contains a json that matches to a swagger definition.
Get a verifier that verifies, if a string contains a json that matches to a swagger definition.
Usually you want to use this to ensure that all your serializers are working.
name
name of the swagger definition to check
returns
a string verifier
val maxItems: Int

default maximum number of items in arrays (or objects with additionalProperties) might be overriden be minItems or maxItems in swagger file
default maximum number of items in arrays (or objects with additionalProperties) might be overriden be minItems or maxItems in swagger file

Definition Classes
SwaggerChecks → GeneratableSchema
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val numberFormats: Map[String, GeneratableFormat[BigDecimal]]

map of all number formats
def operationVerifier[R, U](pathFilter: (String) ⇒ Boolean = _ => true)(implicit requestBuilder: RequestCreator[R], responseExtractor: ResponseExtractor[U]): Gen[OperationValidator[R, U]]

Combines requestGenerator and responseVerifier.
Combines requestGenerator and responseVerifier.
Convenient way to generate arbitrary requests together with a verifier of their expected responses.
R
request class
U
response class
pathFilter
Optional filter for paths (exact match)
def requestGenerator[R](pathFilter: (String) ⇒ Boolean = _ => true)(implicit requestBuilder: RequestCreator[R]): Gen[R]

Create a generator for requests based on a swagger file.
Create a generator for requests based on a swagger file.
R
request class (depends on the web framework, in play FakeRequest might be desired)
pathFilter
Optional filter for paths (exact match)
requestBuilder
implicit creator for request instances
returns
generator for requests
def responseVerifier[R](method: String, path: String)(implicit responseExtractor: ResponseExtractor[R]): Validator[R]

Create response verifier.
Create response verifier.
R
response class (depends on the web framework)
method
method of request
path
path of request
responseExtractor
implicit extractor for response instances
val stringFormats: Map[String, GeneratableFormat[String]]

map of all string formats
val swaggerAPI: SwaggerAPI

the swagger API
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withIntegerFormats(formats: (String, GeneratableFormat[BigInt])*): SwaggerChecks

Add a self-defined integer format.
def withMaxItems(newMaxItems: Int): SwaggerChecks

Modify max items.
Modify max items.

Definition Classes
SwaggerChecks → GeneratableSchema
def withNumberFormats(formats: (String, GeneratableFormat[BigDecimal])*): SwaggerChecks

Add a self-defined number format.
def withStringFormats(formats: (String, GeneratableFormat[String])*): SwaggerChecks

Add a self-defined string format.

Related Docs: object SwaggerChecks | package swaggercheck

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def arbitraryArray: Gen[CheckJsValue]

def arbitraryObj: Gen[CheckJsValue]

def arbitraryProperty: Gen[(String, CheckJsValue)]

def arbitraryValue: Gen[CheckJsValue]

final def asInstanceOf[T0]: T0

def childContext: SwaggerChecks

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

def findByRef(ref: String): Option[Definition]

def findGeneratableIntegerFormat(format: String): Option[GeneratableFormat[BigInt]]

def findGeneratableNumberFormat(format: String): Option[GeneratableFormat[BigDecimal]]

def findGeneratableStringFormat(format: String): Option[GeneratableFormat[String]]

def findIntegerFormat(name: String): Option[ValueFormat[BigInt]]

def findNumberFormat(name: String): Option[ValueFormat[BigDecimal]]

def findStringFormat(name: String): Option[ValueFormat[String]]

final def getClass(): Class[_]

val integerFormats: Map[String, GeneratableFormat[BigInt]]

final def isInstanceOf[T0]: Boolean

def jsonGenerator(name: String): Gen[CheckJsValue]

def jsonVerifier(name: String): Validator[String]

val maxItems: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val numberFormats: Map[String, GeneratableFormat[BigDecimal]]

def operationVerifier[R, U](pathFilter: (String) ⇒ Boolean = _ => true)(implicit requestBuilder: RequestCreator[R], responseExtractor: ResponseExtractor[U]): Gen[OperationValidator[R, U]]

def requestGenerator[R](pathFilter: (String) ⇒ Boolean = _ => true)(implicit requestBuilder: RequestCreator[R]): Gen[R]

def responseVerifier[R](method: String, path: String)(implicit responseExtractor: ResponseExtractor[R]): Validator[R]

val stringFormats: Map[String, GeneratableFormat[String]]

val swaggerAPI: SwaggerAPI

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withIntegerFormats(formats: (String, GeneratableFormat[BigInt])*): SwaggerChecks

def withMaxItems(newMaxItems: Int): SwaggerChecks

def withNumberFormats(formats: (String, GeneratableFormat[BigDecimal])*): SwaggerChecks

def withStringFormats(formats: (String, GeneratableFormat[String])*): SwaggerChecks

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from GeneratableSchema

Inherited from Schema

Inherited from AnyRef

Inherited from Any

Ungrouped