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.
To help keeping your annotations simple, there are a few shortcut annotations available in swagger-php.
Typically, these save you from creating boilerplate nested OA\Schema annotations.
OA\MediaTypeOA\MediaType is used to describe the content of a response.
<<< @/snippets/guide/shortcuts/response_media_type_at.php
<<< @/snippets/guide/shortcuts/response_media_type_an.php
For JSON and Xml content, swagger-php provides shortcut
annotations to avoid having to specify the mediaType over and over again.
Example using OA\JsonContent
<<< @/snippets/guide/shortcuts/response_json_content_at.php
<<< @/snippets/guide/shortcuts/response_json_content_an.php
During processing the OA\JsonContent unwraps to OA\MediaType(mediaType="application/json", OA\Schema(...)
and will generate the same output.
The same applies to OA\XmlContent.
OA\ParameterThe OA\Parameter annotation requires specifying the in property to indicate where in the request the parameter is located.
Shortcut annotations are available for OA\PathParameter, OA\QueryParameter, OA\CookieParameter and OA\HeaderParameter.
How can I help you explore Laravel packages today?