sourcebroker / t3api
为您的 TYPO3 项目提供的 REST API。通过注解进行配置,内置过滤、分页、typolinks、图像处理、序列化上下文和 Hydra/JSON-LD 格式的响应。
3.0.2
2024-07-20 17:50 UTC
Requires
- php: ^8.1.0
- ext-json: *
- ext-pdo: *
- ext-tokenizer: *
- doctrine/annotations: ^1.13.3 || ^2.0
- goldspecdigital/oooas: ^2.4
- jms/serializer: ^3.1
- phpdocumentor/reflection-docblock: ^5.2
- symfony/cache: ^6.4 || ^7.0
- symfony/expression-language: ^6.4 || ^7.0
- symfony/http-foundation: ^6.4 || ^7.0
- symfony/mime: ^6.4 || ^7.0
- symfony/property-info: ^6.4 || ^7.0
- symfony/psr-http-message-bridge: ^6.4 || ^7.0
- symfony/routing: ^6.4 || ^7.0
- typo3/cms-core: ^12.4
- typo3/cms-extbase: ^12.4
- typo3/cms-frontend: ^12.4
Requires (Dev)
- ergebnis/composer-normalize: ^2.29.0
- friendsofphp/php-cs-fixer: ^3.57.1
- phpstan/extension-installer: ^1.2.0
- phpstan/phpstan: ^1.10.67
- phpstan/phpstan-phpunit: ^1.3.16
- phpstan/phpstan-strict-rules: ^1.5.5
- phpunit/phpunit: ^10.5.17
- saschaegerer/phpstan-typo3: ^1.10.0
- seld/jsonlint: ^1.10.2
- symfony/yaml: ^5.4 || ^6.1
- typo3/coding-standards: ^0.8
- typo3/testing-framework: ^7.0.4
- webmozart/assert: ^1.11.0
Replaces
- typo3-ter/t3api: 3.0.2
This package is auto-updated.
Last update: 2024-09-22 17:15:57 UTC
README
功能
- 支持 Extbase 模型进行 GET、POST、PATCH、PUT、DELETE 操作。
- 使用类、属性和方法注解进行配置。
- 内置过滤器:布尔值、数值、排序、范围和文本(部分匹配、匹配和精确策略)。
- 内置分页。
- 支持 typolinks。
- 支持图像处理。
- 支持文件上传(FAL)。
- 可配置的路由。
- 以 Hydra / JSON-LD 格式提供响应。
- 序列化上下文 - 根据路由可自定义输出。
- 易于自定义序列化处理程序和订阅者。
- 具有 Swagger 的后端模块,用于文档和实际测试。
文档
请参阅 https://docs.typo3.org/p/sourcebroker/t3api/master/en-us/
查看并测试
在克隆仓库后,您可以通过运行 ddev restart && ddev composer install
来安装本地集成测试实例,然后运行 ddev ci 12
。本地实例可在 https://12.t3api.ddev.site/ 上找到(使用 admin
/ Password1!
凭据登录后端)。
在前端部分,您可以立即测试 ext news 的 REST API 响应
- https://12.t3api.ddev.site/_api/news/news
- https://12.t3api.ddev.site/_api/news/news/1
- https://12.t3api.ddev.site/_api/news/categories
- 等等
您还可以使用 ddev ci:tests:postman
命令运行 Postman 测试,或使用 ddev composer ci
运行完整的测试套件。Postman 对类别和新闻(带图片)进行完整的 CRUD 测试。
开发
如果您想帮助开发,请查看 https://docs.typo3.org/p/sourcebroker/t3api/main/en-us/Miscellaneous/Development/Index.html