swagger集成到lumen

使用

在 bootstrap中新增, _(*1)

$app->register(Espier\Swagger\Providers\SwaggerServiceProvider::class);

然后执行命令，将swagger UI的资源拷贝到public目录中., _(*2)

php artisan api:swagger --setup

如需生成指定目录的swagger API josn文件则使用, _(*3)

php artisan api:swagger --output=[/path/to/project];

默认JSON文件生成目录为Storage的apidocs中，可通过在.env中新增配置改变存储目录名称, _(*4)

SWAGGER_STORAGE_DIR=apidocs

生成API JSON文件后通过路由访问, _(*5)

http://example.com/api-doc

如果需改变路由名称则可以通过.env配置, _(*6)

SWAGGER_DOCS_ROUTER=api-doc

如果需要使用mock server 则必须安装PHP的Yaml扩展，并且启动mock server服务, _(*7)

php artisan api:swagger --mock-server-start

在开发阶段因为团队中每个人的环境配置不一致，API需要绑定不同的访问地址。那么则不能用API中定义的host和basePath作为测试地址。以便于个人开发测试，那么则可以通过.env配置个人的host和basePath。, _(*8)

SWAGGER_API_HOST=
SWAGGER_API_BASE_PATH=

29/06 2018

9999999-dev

A swagger for lumen

Sources Download

BSD-3-Clause

lumen swagger