justcoded/

yii2-swaggerviewer

此包已被废弃，不再维护。未建议替代包。

多文档yaml规范Swagger查看器

维护者

详细信息

github.com/justcoded/yii2-swaggerviewer

源代码

问题

安装: 59

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 4

分支: 1

开放问题: 0

类型:yii2-extension

dev-master 2018-05-11 13:40 UTC

Requires

MIT 8e0ceb16a2b1a407e63bcbd7f9adc08b04500005

  • Alex Prokopenko <aprokopenko.woop@justcoded.com>

yamlextensionswaggeryii2swagger-merger

This package is auto-updated.

Last update: 2023-09-21 01:09:48 UTC

README

独立yaml/json Swagger文档的查看器。包含Swagger多文档合并器，因此您可以在多个文件中格式化文档以实现更快的编辑。

此包基于我们的SwaggerTools包。

可以在此找到文档查看示例： SwaggerTools文档示例

作为额外功能，您可以提供额外的属性来生成枚举，这些枚举通常由模拟服务器用于生成测试响应。我们推荐使用 Prism 模拟服务器。如果您指定了正确的验证规则（如最小值、最大值、minItems、maxItems等），它将生成由faker php库生成数据的漂亮的模拟。

安装

安装此扩展的首选方式是通过 composer。

运行

php composer.phar require --prefer-dist justcoded/yii2-swaggerviewer "*"

或添加

"justcoded/yii2-swaggerviewer": "*"

到您的 composer.json 文件的require部分。

配置

将模块添加到您的web配置文件中

	'modules' => [
		'swagger' => [
			'class' => \justcoded\yii2\swaggerviewer\Module::class,
			'docsPath' => '@app/docs/swagger/swagger.yaml',

			// use merger tool. if you have single file - can turn it off for faster load.
			'multiDoc' => true,
			
			// enable faker tool. additional link will be provided to download fakered copy.
			'fakerCopy' => true,
			'fakerNum'  => 10, // number of items to generate
		],
	],