agitation/api-bundle

该软件包的规范存储库似乎已消失,因此软件包已被冻结。

安装: 374

依赖项: 3

建议者: 0

安全: 0

星标: 1

关注者: 1

分支: 0

开放问题: 0

类型:symfony-bundle

1.8.4 2018-04-03 14:19 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,以便在客户端简单使用。