agitation / api-bundle
该软件包的规范存储库似乎已消失,因此软件包已被冻结。
1.8.4
2018-04-03 14:19 UTC
Requires
- agitation/base-bundle: ~1.0
- agitation/intl-bundle: ~1.0
- agitation/seed-bundle: ~1.0
- agitation/validation-bundle: ~1.1
Suggests
- agitation/user-bundle: Required to check for user capabilities. Without it, all calls requiring a user capability will fail.
- dev-master
- 1.8.4
- 1.8.3
- 1.8.2
- 1.8.1
- 1.8
- 1.7.3
- 1.7.2
- 1.7.1
- 1.7
- 1.6.5
- 1.6.4
- 1.6.3
- 1.6.2
- 1.6.1
- 1.6
- 1.5.3
- 1.5.2
- 1.5.1
- 1.5
- 1.4.2
- 1.4.1
- 1.4
- 1.3.17
- 1.3.16
- 1.3.15
- 1.3.14
- 1.3.13
- 1.3.12
- 1.3.11
- 1.3.10
- 1.3.9
- 1.3.8
- 1.3.7
- 1.3.6
- 1.3.5
- 1.3.4
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.10
- 1.2.9
- 1.2.8
- 1.2.7
- 1.2.6
- 1.2.5
- 1.2.4
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2
- 1.1.1
- 1.1
- 1.0
This package is not auto-updated.
Last update: 2022-07-24 12:08:56 UTC
README
Agitation 是一个基于 Symfony2 的电子商务框架,通过插件化的 API、UI、支付模块和其他组件来实现扩展性。
AgitApiBundle
此包提供了一个可插拔的 API 处理器。它允许其他包定义它们自己的独立 API 端点、调用和请求/响应对象。
API URL
一个简单的调用可能看起来像这样
https://example.com/api/namespace.v1/ExampleEndpoint.doSomething?request={"foo":"bar"}
namespace ^^^^^^^^^
namespace version ^^
controller name ^^^^^^^^^^^^^^^
endpoint name ^^^^^^^^^^^
actual request ^^^^^^^^^^^^^^^^^^^^^
API 注释
控制器、端点和对象都进行了注释,这些注释提供了元信息,以确保一致的 API 调用,例如
- 身份验证/授权:端点调用定义了访问调用所需的权限(通过
agitation/user
)。 - 验证:预期的请求/响应对象及其允许的值。
- 自动文档:AgitSdkDocBundle 提供了自动生成 Markdown 文档的工具。
- 将 API 端点和对象导出到 JavaScript,以便在客户端简单使用。