rayenbou / ticket-bundle
用于管理票据的Symfony扩展包
1.0
2024-06-29 21:20 UTC
This package is auto-updated.
Last update: 2024-09-05 17:04:25 UTC
README
本项目提供对票据系统的Symfony集成,允许从指定的API获取单个票据和票据列表。它使用Symfony HttpClient组件与API通信,并通过JWT Token的bearer令牌进行身份验证。
本项目旨在与Dashboard Bundle一起使用。
DashboardBundle部分可以安装到您的应用程序中,而TicketBundle部分可以安装到任何其他应用程序中。
本文档提供了为您的项目设置票据环境的分步指南。
目前该项目处于alpha阶段,目前还没有任何食谱,但它可能很快就会改变。
如何使用它
- 在您的.env文件中注册
TICKET_URL
、TICKET_USERNAME
和TICKET_PASSWORD
(使用Dashboard Bundle创建用户名和密码)。 - 转到
/ticket/
。 - 发送票据,通过类似聊天机的对话进行回答。
- 如果票据已关闭,则无法再对其进行回答。
初始设置
-
Composer
composer require rayenbou/dashboard-bundle
注意
如果您在项目中启用了Symfony/flex
,则在执行cache:clear时可能会出现错误,提示“缺少认证密钥”。不要担心这个问题,您只需按照参数设置进行操作。
-
参数设置
在
config/packages/rayenbou_ticket.yaml
rayenbou_ticket: authentication: url: '%env(TICKET_URL)%' username: '%env(TICKET_USERNAME)%' password: '%env(TICKET_PASSWORD)%' settings: verify_peer: false
在
config/routes/rayenbou_ticket.yaml
rayenbou_ticket: resource: "@RayenbouTicketBundle/Resources/config/routing.yaml"
在
.env
TICKET_URL= TICKET_USERNAME= TICKET_PASSWORD=
开发环境
在config/packages/rayenbou_ticket.yaml
设置中的键verify_peer
默认为false
,以便在自验证的TLS环境中工作,如果您在其它环境中工作,可以自由地将其禁用。
测试
单元测试和集成测试正在路上。
演变
- 可以覆盖所有模板和控制器。
贡献
欢迎对本项目的贡献。请确保遵循现有的编码风格,并为任何新的或更改的功能添加单元测试。
请使用PHPstan
和PHP-CS-FIXER
。
许可
本项目采用MIT许可 - 有关详细信息,请参阅LICENSE文件。