PHPackages                             carlin/laravel-data-swagger - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. carlin/laravel-data-swagger

ActiveLibrary[API Development](/categories/api)

carlin/laravel-data-swagger
===========================

v1.0.0(1y ago)04PHPPHP >=8.1

Since Jan 9Pushed 1y ago1 watchersCompare

[ Source](https://github.com/carlin-rj/laravel-data-swagger)[ Packagist](https://packagist.org/packages/carlin/laravel-data-swagger)[ RSS](/packages/carlin-laravel-data-swagger/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (6)Versions (2)Used By (0)

Laravel Data Swagger
====================

[](#laravel-data-swagger)

Laravel对象注解生成swagger API 文档。依赖于l5-swagger拓展配置, 本项目只是简化生成文档的对象属性配置。

功能特性
----

[](#功能特性)

- 支持自定义 API 响应格式
- 支持多文档配置
- 支持驼峰/下划线文档生成

安装
--

[](#安装)

通过 Composer 安装:

```
composer require carlin/laravel-data-swagger
```

发布配置文件:

```
php artisan vendor:publish --provider="Carlin\LaravelDataSwagger\LaravelDataSwaggerServiceProvider"
```

配置
--

[](#配置)

配置文件位于 `config/laravel-data-swagger.php`:

```
return [
    'documentations' => [
        'default' => [
            // 某些场景后端是下划线命名，接收方是驼峰命名，需要定义了这个配置来兼容转换
            // 文档，响应格式和请求格式(true:驼峰/false:下划线)
            'is_camel' => true,

            // 后端对象属性格式(true:驼峰/false:下划线)
            'object_is_camel' => false,

            // 响应格式配置
            'response_format' => [
                // 基础响应字段
                'base_properties' => [
                    'state' => [
                        'field' => 'state',
                        'type' => 'string',
                        'description' => 'response code',
                        'example' => '000001'
                    ],
                    'msg' => [
                        'field' => 'msg',
                        'type' => 'string',
                        'description' => 'response message',
                        'example' => 'success'
                    ],
                    // 更多自定义字段...
                ],
                // 数据字段名
                'data_field' => 'data',
            ],
        ],
        // 可配置多个文档...
        // 'api_v2' => [
        //
        //],
    ],
];
```

使用方法
----

[](#使用方法)

### 文档属性

[](#文档属性)

```