通过
进行搜索
进行搜索gossi / swagger
一个用于操作swagger规范的PHP库
v0.3
2016-11-16 16:49 UTC
Requires
- php: >=5.4
- phootwork/collection: ~1
- phootwork/file: ~0
- phootwork/json: ~1
Requires (Dev)
- phpunit/phpunit: ~4
This package is auto-updated.
Last update: 2024-09-20 22:58:35 UTC
README
一个用于操作swagger/Open API规范的PHP库。
安装
composer require gossi/swagger
使用方法
读取api.json文件
$swagger = Swagger::fromFile('api.json'); // or $swagger = new Swagger($array);
集合
有两个主要集合：Paths和Definitions。API在这两者中是相似的。
$paths = $swagger->getPaths(); $p = new Path('/user'); // adding $paths->add($p); // retrieving if ($paths->has('/user') || $paths->contains($p)) { $path = $paths->get('/user'); } // removing $paths->remove('/user'); // iterating foreach ($paths as $path) { // do sth with $path }
其他集合包括：Headers、Parameters、Responses和SecurityDefinitions。
模型
有很多模型，例如上面提到的Path。API编写良好，可以与IDE的自动完成功能一起使用。它简单直接，并使用与OpenAPI规范相同的命名方案。
贡献
请随意Fork并提交pull request（别忘了测试），我很乐意合并。