neondigital/openapi-spec-generator

为 Laravel JSON:API 创建 Open API 规范

维护者

详细信息

github.com/neondigital/openapi-spec-generator

源代码

问题

安装: 721

依赖项: 0

建议者: 0

安全性: 0

星标: 6

关注者: 3

分支: 19

开放问题: 1

dev-master 2021-04-29 21:48 UTC

Requires

Requires (Dev)

Apache-2.0 cb06ad8b9c0b4c09b2a1500267416e6c4aa1ac27

This package is auto-updated.

Last update: 2024-08-29 05:49:59 UTC

README

设计用于与 Laravel JSON:API 一起使用

!!! 声明：此项目仍在开发中，可能包含许多错误等 !!!

待办事项

  • 命令用于生成存储文件夹
  • 使用 GitHub Actions 运行基本测试套件
  • 通过配置添加额外的操作描述
  • 通过配置添加标签 & x-tagGroups
  • 在路由中考虑使用 ->readonly() 等
  • 在保存资源时从有效负载数据中删除链接
  • 修复包含和关系
  • 整理代码！！
  • 添加测试

🙏 基于 martianatwork 的初始原型

使用方法

安装包

composer install neondigital/openapi-spec-generator

发布配置文件

php artisan vendor:publish --provider="LaravelJsonApi\OpenApiSpec\OpenApiServiceProvider"

生成 Open API 规范

php artisan jsonapi:openapi:generate v1

生成文档

预览文档的快捷方式是使用 Speccy。请确保您已全局安装 Speccy，然后可以使用以下命令。

speccy serve storage/app/v1_openapi.yaml