ContextQMD
Libraries
Rankings
Queue
About
Log in
Get started
Open menu
Back to Libraries
Swagger Php
swagger-php
GitHub
swagger-php
zircote/swagger-php
swaggerphp
zircoteswaggerphp
zircote
Homepage
4 versions
31 pages (6.1.2)
5 aliases
4
Versions
31
Pages (6.1.2)
5
Aliases
Pages
Versions
Usage
6.1.2
▼
stable
Readme
Custom processors
github.com/zircote/swagger-php/blob/6.1.2/docs/...
1.5 KB
Full page
Augmentation
Summary and description
References
Tags
github.com/zircote/swagger-php/blob/6.1.2/docs/...
2.4 KB
Full page
Cookbook
Adding examples to `@OA\Response`
External documentation
Properties with union types
Referencing a security scheme
+16 more
github.com/zircote/swagger-php/blob/6.1.2/docs/...
14.9 KB
Full page
Enums
Enum cases
Backed enums
Default behaviour for backed enums
Using the backing value of an enum
github.com/zircote/swagger-php/blob/6.1.2/docs/...
3.0 KB
Full page
Example Reference
Server.php
Product.php
NameTrait.php
Colour.php
+22 more
github.com/zircote/swagger-php/blob/6.1.2/docs/...
6.7 KB
Full page
FAQ
Annotations missing
Skipping unknown `\SomeClass`
Using the `-b` `--bootstrap` option
Namespace mismatch
+1 more
github.com/zircote/swagger-php/blob/6.1.2/docs/...
5.5 KB
Full page
Generating OpenAPI documents
Using PHP
github.com/zircote/swagger-php/blob/6.1.2/docs/...
2.6 KB
Full page
What is Swagger-PHP?
github.com/zircote/swagger-php/blob/6.1.2/docs/...
944 B
Full page
Installation
Globally
Type resolvers
Using doctrine annotations
github.com/zircote/swagger-php/blob/6.1.2/docs/...
1.4 KB
Full page
Migrating to v3
Updated CLI
Changed annotations
SWG is renamed to OA
@SWG\Swagger() is renamed to @OA\OpenApi()
+8 more
github.com/zircote/swagger-php/blob/6.1.2/docs/...
1.7 KB
Full page
Migrating to v4
Annotations as PHP attributes
Using annotations
Using attributes
Optional nesting
+9 more
github.com/zircote/swagger-php/blob/6.1.2/docs/...
5.4 KB
Full page
Migrating to v5
Removed deprecated elements
`\Openapi\Generator::getProcessors()` and `\Openapi\Generator::setProcessors()`
github.com/zircote/swagger-php/blob/6.1.2/docs/...
798 B
Full page
Migrating to v6
Type resolvers
Removed deprecated elements
Methods `\Openapi\Generator::getProcessors()` and `\Openapi\Generator::setProcessors()`
Static method `\Openapi\Generator::scan()`
+1 more
github.com/zircote/swagger-php/blob/6.1.2/docs/...
1.5 KB
Full page
Minimum requirements
Optional elements
Annotation placement
github.com/zircote/swagger-php/blob/6.1.2/docs/...
1.9 KB
Full page
References
github.com/zircote/swagger-php/blob/6.1.2/docs/...
1.5 KB
Full page
Shortcuts
`OA\Parameter`
github.com/zircote/swagger-php/blob/6.1.2/docs/...
1.4 KB
Full page
Under the hood
`Context`
Analysis
Documentation
Installation
+1 more
github.com/zircote/swagger-php/blob/6.1.2/docs/...
1.8 KB
Full page
Annotations
Escaping
Arrays and Objects
Constants
github.com/zircote/swagger-php/blob/6.1.2/docs/...
3.8 KB
Full page
Attributes
github.com/zircote/swagger-php/blob/6.1.2/docs/...
1.3 KB
Full page
Vendor extensions
github.com/zircote/swagger-php/blob/6.1.2/docs/...
773 B
Full page
Index
2. Update your code
3. Generate OpenAPI documentation
4. Explore and interact with your API
Links
github.com/zircote/swagger-php/blob/6.1.2/docs/...
1.3 KB
Full page
Annotation Reference
[AdditionalProperties](https://github.com/zircote/swagger-php/tree/master/src/Annotations/AdditionalProperties.php)
Allowed in
Nested elements
[Attachable](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Attachable.php)
+177 more
github.com/zircote/swagger-php/blob/6.1.2/docs/...
86.6 KB
Full page
Attribute Reference
[AdditionalProperties](https://github.com/zircote/swagger-php/tree/master/src/Attributes/AdditionalProperties.php)
Allowed in
Nested elements
Parameters
+160 more
github.com/zircote/swagger-php/blob/6.1.2/docs/...
304.3 KB
Full page
Using the `Generator`
The `\OpenApi\Generator` class
Full example of using the `Generator` class to generate OpenApi specs
Basic example
github.com/zircote/swagger-php/blob/6.1.2/docs/...
2.3 KB
Full page
Reference
github.com/zircote/swagger-php/blob/6.1.2/docs/...
853 B
Full page
Processor Reference
Command line
Programmatically with PHP
Default Processors
[DocBlockDescriptions](https://github.com/zircote/swagger-php/tree/master/src/Processors/DocBlockDescriptions.php)
+30 more
github.com/zircote/swagger-php/blob/6.1.2/docs/...
9.2 KB
Full page
Related projects
github.com/zircote/swagger-php/blob/6.1.2/docs/...
2.5 KB
Full page
Preamble Annotations
github.com/zircote/swagger-php/blob/6.1.2/docs/...
162 B
Full page
Preamble Attributes
github.com/zircote/swagger-php/blob/6.1.2/docs/...
162 B
Full page
Preamble Processors
github.com/zircote/swagger-php/blob/6.1.2/docs/...
58 B
Full page
1–30 of 31
1
2
Page 1