OpenAPI / Swagger
Document your PHP API with OpenAPI 3.0 spec for auto-generated interactive docs, client SDKs, and contract testing.
PHP
Intermediate
4 min read
API Documentation with OpenAPI
Example
# Install L5-Swagger (Laravel OpenAPI)
composer require darkaonline/l5-swagger
# Annotate controllers with PHP attributes
/**
* @OA\Get(path="/api/users", summary="List users",
* @OA\Response(response=200, description="Success",
* @OA\JsonContent(type="array", @OA\Items(ref="#/components/schemas/User"))
* )
* )
*/
# Generate: php artisan l5-swagger:generate
# Docs at: /api/documentation Pro Tip
Good API documentation reduces integration time for consumers and acts as a living contract.