OpenAPI
use Native\Api\Config\Internals\OpenApiConfig;
$value = OpenApiConfig::OPENAPI;
Документ
| Константа | Значение |
|---|
| OPENAPI | openapi |
| INFO | info |
| TITLE | title |
| VERSION | version |
| TERMS_OF_SERVICE | termsOfService |
| CONTACT | contact |
| LICENSE | license |
| EMAIL | email |
| URL | url |
| PATHS | paths |
| COMPONENTS | components |
| SCHEMAS | schemas |
| SECURITY_SCHEMES | securitySchemes |
| SCHEME | scheme |
Операции
| Константа | Значение |
|---|
| TAGS | tags |
| SUMMARY | summary |
| DESCRIPTION | description |
| EXTERNAL_DOCS | externalDocs |
| OPERATION_ID | operationId |
| PARAMETERS | parameters |
| REQUEST_BODY | requestBody |
| RESPONSES | responses |
| CALLBACKS | callbacks |
| DEPRECATED | deprecated |
| SECURITY | security |
| SERVERS | servers |
Параметры и схемы
| Константа | Значение |
|---|
| NAME | name |
| IN | in |
| REQUIRED | required |
| SCHEMA | schema |
| CONTENT | content |
| TYPE | type |
| FORMAT | format |
| PROPERTIES | properties |
| ITEMS | items |
| ENUM | enum |
| MINIMUM | minimum |
| MAXIMUM | maximum |
| MIN_ITEMS | minItems |
| MAX_ITEMS | maxItems |
| NULLABLE | nullable |
| ADDITIONAL_PROPERTIES | additionalProperties |
| ONE_OF | oneOf |
| ALL_OF | allOf |
| REF | $ref |
| EXAMPLE | example |
| EXAMPLES | examples |
| VALUE | value |
Общие схемы ответа
| Константа | Значение |
|---|
| SCHEMA_RESPONSE_TIME | ResponseTime |
| SCHEMA_RESPONSE_STATUS | ResponseStatus |
| SCHEMA_RESPONSE_ERROR | ResponseError |