francodacosta / caparica-bundle
一个 symfony 扩展包,用于通过签名请求来帮助保护您的 REST API
1.0
2014-10-04 22:09 UTC
Requires
- php: >=5.3.0
- francodacosta/caparica: ~1.0
Requires (Dev)
- mockery/mockery: dev-master@dev
README
开始使用 Caparica Bundle
安装
1. Download CaparicaBundle using composer
2. Enable the Bundle
3. add a client
4. Configure your controller
步骤1:使用 composer 下载 CaparicaBundle
通过以下命令添加 CaparicaBundle:
$ php composer.phar require francodacosta/caparica-bundle '~1.0'
步骤2:启用扩展包
在 kernel 中启用扩展包
<?php // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new Francodacosta\CaparicaBundle\FrancodacostaCaparicaBundle(), ); }
步骤3:配置客户端
为了服务器能够验证客户端签名,它需要知道客户端/api ID 和密钥
如果使用 YamlClientProvider
,请编辑文件:app/config/caparica.yml
client_alias: code: "the client code" secret: "the client api secret"
将以下内容添加到您的 app/config.yml
文件中
francodacosta_caparica: client_provider_id: francodacosta.caparica.client.provider.yaml
步骤4:配置控制器
确保您的控制器实现了 Francodacosta\CaparicaBundle\Controller\CaparicaControllerInterface
。 Francodacosta\CaparicaBundle\Controller\CaparicaController
扩展了 Symfony 控制器,并有一些方便的方法。
这样,所有通过路由访问的控制器操作都需要进行签名