terwey/slim-swagger

Slim中间件，使用Swagger-PHP动态生成Swagger文档

维护者

详细信息

github.com/terwey/SlimSwagger

源代码

问题

安装次数: 532

依赖项: 0

建议者: 0

安全性: 0

星标: 16

关注者: 2

分支: 3

开放问题: 1

0.0.3 2015-01-24 14:15 UTC

Requires

MIT 5a711338e1635812e6fe804fa4bfa0748e89ed0b

  • Yorick Terweijden <terwey.woop@gmail.com>

This package is not auto-updated.

Last update: 2024-09-14 17:11:06 UTC

README

这是一个使用Swagger-PHP动态生成Swagger文档的Slim中间件。

安装

最简单的方式是使用Composer

composer require terwey/slim-swagger

将它添加到Slim中也很简单

$app->add(new \terwey\SlimSwagger(array(), array('baseDir' => __DIR__.'/../src/')));

其中 src/ 是你保存API端点或模型的目录。

资源

目前，您需要下载Swagger-UI的版本，并将/lib和/css复制到您的/public目录。同时，将swagger-ui.min.js复制到/public/lib目录。

模板

我在/templates目录提供了一个Twig模板。将它复制到您的Slim应用程序中。如果您想使用Twig，还需要安装Slim Views。

文档

SlimSwagger类接受2个参数。第一个是$swaggerSettings数组，请参阅Swagger-PHP文档以获取更多信息。

$swaggerSettings = array(
    'output' => 'json',
    'apiVersion' => $defaultApiVersion,
    'swaggerVersion' => $defaultSwaggerVersion,
    'defaultSwaggerVersion' => $resourceList['swaggerVersion'],
    'defaultBasePath' => $defaultBasePath
);

第二个是$options数组。

$options = array(
    'baseDir' => __DIR__.'/../',
    'ignoreDir' => array()
);