PHP 클래스 Swagger\Annotations\Parameter

상속: extends AbstractAnnotation
파일 보기 프로젝트 열기: zircote/swagger-php 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$_nested
$_parents
$_required
$_types
$collectionFormat string Determines the format of the array if type array is used. Possible values are: csv - comma separated values foo,bar. ssv - space separated values foo bar. tsv - tab separated values foo\tbar. pipes - pipe separated values foo|bar. multi - corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz. This is valid only for parameters in "query" or "formData". Default value is csv.
$default mixed Sets a default value to the parameter. The type of the value depends on the defined type. See http://json-schema.org/latest/json-schema-validation.html#anchor101.
$description string A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.
$enum array See http://json-schema.org/latest/json-schema-validation.html#anchor76.
$exclusiveMaximum boolean See http://json-schema.org/latest/json-schema-validation.html#anchor17.
$exclusiveMinimum boolean See http://json-schema.org/latest/json-schema-validation.html#anchor21.
$format string The extending format for the previously mentioned type. See Data Type Formats for further details.
$in string The location of the parameter. Possible values are "query", "header", "path", "formData" or "body".
$items array Required if type is "array". Describes the type of items in the array.
$maxItems integer See http://json-schema.org/latest/json-schema-validation.html#anchor42.
$maxLength integer See http://json-schema.org/latest/json-schema-validation.html#anchor26.
$maximum number See http://json-schema.org/latest/json-schema-validation.html#anchor17.
$minItems integer See http://json-schema.org/latest/json-schema-validation.html#anchor45.
$minLength integer See http://json-schema.org/latest/json-schema-validation.html#anchor29.
$minimum number See http://json-schema.org/latest/json-schema-validation.html#anchor21.
$multipleOf number See http://json-schema.org/latest/json-schema-validation.html#anchor14.
$name string The name of the parameter. Parameter names are case sensitive. If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information. For all other cases, the name corresponds to the parameter name used based on the in property.
$parameter string The key into Swagger->parameters or Path->parameters array.
$pattern string See http://json-schema.org/latest/json-schema-validation.html#anchor33.
$ref string $ref See http://json-schema.org/latest/json-schema-core.html#rfc.section.7
$required boolean Determines whether this parameter is mandatory. If the parameter is in "path", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is false.
$schema Schema The schema defining the type used for the body parameter.
$type string The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). The value MUST be one of "string", "number", "integer", "boolean", "array" or "file". If type is "file", the consumes MUST be either "multipart/form-data" or " application/x-www-form-urlencoded" and the parameter MUST be in "formData".
$uniqueItems boolean See http://json-schema.org/latest/json-schema-validation.html#anchor49.

공개 메소드들

메소드 설명
identity ( )
validate ( $parents = [], $skip = [] )

메소드 상세

identity() 공개 메소드

public identity ( )

validate() 공개 메소드

public validate ( $parents = [], $skip = [] )

프로퍼티 상세

$_nested 공개적으로 정적으로 프로퍼티

public static $_nested

$_parents 공개적으로 정적으로 프로퍼티

public static $_parents

$_required 공개적으로 정적으로 프로퍼티

public static $_required

$_types 공개적으로 정적으로 프로퍼티

public static $_types

$collectionFormat 공개적으로 프로퍼티

Determines the format of the array if type array is used. Possible values are: csv - comma separated values foo,bar. ssv - space separated values foo bar. tsv - tab separated values foo\tbar. pipes - pipe separated values foo|bar. multi - corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz. This is valid only for parameters in "query" or "formData". Default value is csv.
public string $collectionFormat
리턴 string

$default 공개적으로 프로퍼티

Sets a default value to the parameter. The type of the value depends on the defined type. See http://json-schema.org/latest/json-schema-validation.html#anchor101.
public mixed $default
리턴 mixed

$description 공개적으로 프로퍼티

A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.
public string $description
리턴 string

$enum 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor76.
public array $enum
리턴 array

$exclusiveMaximum 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor17.
public bool $exclusiveMaximum
리턴 boolean

$exclusiveMinimum 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor21.
public bool $exclusiveMinimum
리턴 boolean

$format 공개적으로 프로퍼티

The extending format for the previously mentioned type. See Data Type Formats for further details.
public string $format
리턴 string

$in 공개적으로 프로퍼티

The location of the parameter. Possible values are "query", "header", "path", "formData" or "body".
public string $in
리턴 string

$items 공개적으로 프로퍼티

Required if type is "array". Describes the type of items in the array.
public array $items
리턴 array

$maxItems 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor42.
public int $maxItems
리턴 integer

$maxLength 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor26.
public int $maxLength
리턴 integer

$maximum 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor17.
public number $maximum
리턴 number

$minItems 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor45.
public int $minItems
리턴 integer

$minLength 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor29.
public int $minLength
리턴 integer

$minimum 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor21.
public number $minimum
리턴 number

$multipleOf 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor14.
public number $multipleOf
리턴 number

$name 공개적으로 프로퍼티

The name of the parameter. Parameter names are case sensitive. If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information. For all other cases, the name corresponds to the parameter name used based on the in property.
public string $name
리턴 string

$parameter 공개적으로 프로퍼티

The key into Swagger->parameters or Path->parameters array.
public string $parameter
리턴 string

$pattern 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor33.
public string $pattern
리턴 string

$ref 공개적으로 프로퍼티

$ref See http://json-schema.org/latest/json-schema-core.html#rfc.section.7
public string $ref
리턴 string

$required 공개적으로 프로퍼티

Determines whether this parameter is mandatory. If the parameter is in "path", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is false.
public bool $required
리턴 boolean

$schema 공개적으로 프로퍼티

The schema defining the type used for the body parameter.
public Schema,Swagger\Annotations $schema
리턴 Schema

$type 공개적으로 프로퍼티

The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). The value MUST be one of "string", "number", "integer", "boolean", "array" or "file". If type is "file", the consumes MUST be either "multipart/form-data" or " application/x-www-form-urlencoded" and the parameter MUST be in "formData".
public string $type
리턴 string

$uniqueItems 공개적으로 프로퍼티

See http://json-schema.org/latest/json-schema-validation.html#anchor49.
public bool $uniqueItems
리턴 boolean