Download the PHP package auto-swagger/php-swagger-generator without Composer

Laravel Auto Swagger Documentation

Auto Swagger for Laravel is a package that helps you generate Swagger/OpenAPI 1.0 documentation quickly and easily for your Laravel applications.

Installation

1. Install the package via Composer:

2. Publish the necessary files:

Generating Documentation

To generate the OpenAPI documentation, run:

Output Format Options

The generator supports both JSON and YAML formats:

• Generate JSON (default):

• Generate YAML:

When using the default JSON format, the documentation will be accessible at: http://localhost:8000/api/documentation/json

1. All attributes must be written in controller

2. If you are using resource controller write apiResource instead resource

3. Remove unused and Deleted controller usings namespaces

Attributes

Route Documentation

To include a route in the API documentation, use the ApiSwagger attribute:

Properties:

• summary: Description of the route
• tag: Group identifier for related routes

Request Documentation

Document request parameters using ApiSwaggerRequest:

On the controller method you need use Request class for validation, if you does not do this AutoSwager will not parse RequestBody

Query Parameters

Use ApiSwaggerQuery to define filter parameters for your API endpoints:

if you need paste id Of model you need make isId parameter true

The format for each query parameter is: 'parameter_name' => 'type|required/optional|description'

Supported types:

• string
• integer
• boolean
• date
• array
• float

Example of a complete endpoint with query parameters:

Response Documentation

Document API responses using ApiSwaggerResponse. You can specify the response structure in three ways:

1. Using an array:

2. Using an API Resource class:

3. Using a Model class:

Resource class

Pagination Support

To implement pagination in your API documentation:

1. Create a paginated resource class that extends PaginatedResource:

2. Set isPagination to true in your ApiSwaggerResponse attribute:

For each reload on api/documentation route regenerate docs set environment:

Support

For support, feedback, or questions, contact the maintainer at: [email protected]