exsyst/swagger

一个用于操作 Swagger 规范的 PHP 库

维护者

详细信息

github.com/GuilhemN/swagger

源代码

问题

安装次数: 14,311,143

依赖者: 8

建议者: 0

安全性: 0

星标: 362

关注者: 3

分支: 18

开放问题: 2

v0.4.2 2020-11-19 17:14 UTC

Requires

  • php: ^7.0|^8.0

Requires (Dev)

MIT 5d4ad40fe816b7783adc090b64fba6c392be64bc

  • Guilhem Niot <guilhem.woop@gniot.fr>

This package is auto-updated.

Last update: 2024-08-27 23:50:21 UTC

README

Build Status Scrutinizer Code Quality Code Coverage

一个用于操作 Swagger/Open API 规范的 PHP 库。

安装

composer require EXSyst/Swagger

使用方法

读取 api.json 文件

$swagger = Swagger::fromFile('api.json');

// or

$swagger = new Swagger($array);

集合

主要有两个集合： Paths 和 Definitions。API 对于两者都是类似的

$paths = $swagger->getPaths();
$p = new Path('/user');

foreach ($paths as $path) {
	// adding
	$paths->add($a);
	
	// retrieving
	if ($paths->has('/user') || $paths->contains($p)) {
		$path = $paths->get('/user');
	}
	
	// removing
	$paths->remove('/user');
}

模型

有很多模型，例如上面提到的 Path。API 编写良好，因此它与 IDE 的自动完成功能兼容。它是直接的，并且使用与 OpenAPI 规范相同的命名方案。

贡献

请随意进行分支并提交一个 pull request（不要忘记测试），我会很高兴合并。