通过
搜索
搜索th3mouk/ openapi-generator
PHP库，提供脚手架和生成OpenAPI文件
0.3.0
2020-07-23 09:48 UTC
Requires
- php: >=7.4
- ext-json: *
- symfony/console: ^4.1|^5.0
- symfony/finder: ^4.1|^5.0
- symfony/yaml: ^4.1|^5.0
Requires (Dev)
- phpstan/phpstan: ^0.12.33
- youdot/coding-standard: ^3.0
README
此PHP库允许您将巨大的openapi.yml文件分割并组织成小块。
版本控制和部署OpenAPI文档变得更加容易。
安装
composer require th3mouk/openapi-generator
使用方法
在您的项目中，您现在可以运行额外的命令
vendor/bin/openapi scaffoldvendor/bin/openapi generate
脚手架
为了准备您的项目，运行第一个命令scaffold。
它将创建新的文件夹。
specs ├── components │ ├── schemas │ ├── responses │ ├── parameters │ ├── examples │ ├── requestBodies │ ├── headers │ ├── securitySchemes │ ├── links │ └── callbacks └── paths
添加您的模式
我使用Swagger OpenAPI规范来编写我的模式。
组织的一个例子可以是
specs
├── components
└── paths
├── authentication
│ ├── login.yaml
│ └── register.yaml
└── unicorn
├── list.yaml
└── detail.yaml
生成
vendor/bin/openapi generate命令接受参数和选项以生成openapi.yml文件。
您可以通过这种方式添加路径vendor/bin/openapi generate /in-this-folder/sub
还有一个--pretty-json或-p选项，可以获得可读性强的文件。
请
欢迎改进此库。