zircote/swagger-php
swagger-php generates OpenAPI 3.0/3.1/3.2 documentation from your PHP 8.2+ code using attributes (preferred) or optional Doctrine annotations. Use it via CLI or programmatically, with helpful error reporting and a full documentation site.
This page is generated automatically from the swagger-php sources.
For improvements head over to GitHub and create a PR ;)
In addition to this page, there are also a number of examples which might help you out.
Schema, Property, Items, JsonContent, XmlContent, AdditionalProperties
Discriminator, Items, Property, ExternalDocumentation, Xml, AdditionalProperties, Attachable
A container for custom data to be attached to an annotation.
These will be ignored by swagger-php but can be used for custom processing.
AdditionalProperties, Components, Contact, Delete, Discriminator, Encoding, Examples, ExternalDocumentation, Flow, Get, Head, Header, Info, Items, JsonContent, License, Link, MediaType, OpenApi, Operation, Options, Parameter, Patch, PathItem, PathParameter, Post, Property, Put, RequestBody, Response, Schema, SecurityScheme, Server, ServerVariable, Tag, Trace, Webhook, Xml, XmlContent
Holds a set of reusable objects for different aspects of the OA.
All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.
OpenApi
Response, Parameter, PathParameter, RequestBody, Examples, Header, SecurityScheme, Link, Schema, Attachable
Contact information for the exposed API.
Info
Attachable
A @OA\Request cookie parameter.
Components, PathItem, Operation, Get, Post, Put, Delete, Patch, Head, Options, Trace
Schema, Examples, Attachable
PathItem
Parameter, PathParameter, Response, ExternalDocumentation, Server, RequestBody, Attachable
The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.
This object is based on the JSON Schema Specification and uses a predefined subset of it. On top of this subset, there are extensions provided by this specification to allow for more complete documentation.
Schema, Property, AdditionalProperties, Items, JsonContent, XmlContent
Attachable
A single encoding definition applied to a single schema property.
JsonContent, XmlContent, MediaType, Property
Header, Attachable
Components, Schema, Parameter, PathParameter, MediaType, JsonContent, XmlContent
Attachable
Allows referencing an external resource for extended documentation.
OpenApi, Tag, Schema, AdditionalProperties, Property, Operation, Get, Post, Put, Delete, Patch, Head, Options, Trace, Items, JsonContent, XmlContent
Attachable
Configuration details for a supported OAuth flow.
SecurityScheme
Attachable
PathItem
Parameter, PathParameter, Response, ExternalDocumentation, Server, RequestBody, Attachable
PathItem
Parameter, PathParameter, Response, ExternalDocumentation, Server, RequestBody, Attachable
Encoding, Components, Response
Schema, Attachable
A @OA\Request header parameter.
Components, PathItem, Operation, Get, Post, Put, Delete, Patch, Head, Options, Trace
Schema, Examples, Attachable
How can I help you explore Laravel packages today?