通过 
搜索
搜索nasrulhazim / oas
OAS，开放API规范生成器。
dev-master
2019-10-13 03:51 UTC
Requires
- php: ^7.1.3
- doctrine/dbal: ^2.9
- illuminate/database: 5.8.*
- illuminate/log: 5.8.*
- intonate/tinker-zero: ^1.0
- laravel-zero/framework: 5.8.*
- zendframework/zend-text: ^2.7
Requires (Dev)
- mockery/mockery: ^1.0
- phpunit/phpunit: ^7.5
This package is auto-updated.
Last update: 2024-09-13 15:09:14 UTC
README
OAS 是一个 OpenAPI 规范生成器。它可以帮助您从给定的数据库中简化 OAS 的生成。
用法
创建新的 OAS
$ php oas make:oas 1.0
这将创建一个新的 OAS 在 storage/oas/1.0 之下。您应该有以下目录结构
创建新的 OAS 模式
$ php oas make:schema 1.0 table_name --connection=database_connection_name
如果您打算使用除默认连接
sqlite之外的其他连接，则需要指定--connection选项
这将在 storage/oas/1.0/components/schemas 目录下生成一个新的标签。
创建新的 OAS 标签
$ php oas make:tag 1.0 "Name of the tag" "Description of the tag"
这将在 storage/oas/1.0/tags 目录下生成一个新的标签。
创建新的路径
$ php oas make:path 1.0 get "Name of the tag" table_name operation_id --summary="Summary is optional, but best to have it together."
这将在 storage/oas/1.0/paths 目录下生成一个新的标签。
许可证
OAS 是一个开源软件，遵循 MIT 许可证。