staegi / symfony-rest-api
“Symfony2 REST API”项目
v1.0.0
2016-02-04 10:32 UTC
Requires
- php: >=5.4.0
- doctrine/doctrine-bundle: ~1.4
- doctrine/doctrine-fixtures-bundle: ^2.2
- doctrine/orm: ^2.4.8
- friendsofsymfony/oauth-server-bundle: ^1.4
- friendsofsymfony/rest-bundle: ^1.7
- friendsofsymfony/user-bundle: ^1.3
- incenteev/composer-parameter-handler: ~2.0
- jms/serializer-bundle: ^1.1
- liip/monitor-bundle: ^2.1
- nelmio/api-doc-bundle: ^2.10
- nelmio/cors-bundle: ^1.4
- sensio/distribution-bundle: ~4.0
- sensio/framework-extra-bundle: ^3.0.2
- symfony/assetic-bundle: ~2.3
- symfony/monolog-bundle: ~2.4
- symfony/swiftmailer-bundle: ~2.3
- symfony/symfony: 2.8.*
Requires (Dev)
This package is not auto-updated.
Last update: 2024-09-20 18:59:21 UTC
README
这是一个创建一个提供数据库REST接口的应用程序的不错起点。
#需求
- git
- MySQL
- PHP 5.4或更高版本
- Apache 2或Nginx
- Composer
#安装
创建带供应商的项目
curl -sS https://getcomposer.org/installer | php
composer.phar create-project staegi/symfony-rest-api
cd symfony-rest-api
创建开发数据库
php bin/console doctrine:database:create -e dev
php bin/console doctrine:schema:create -e dev
加载固定数据来创建第一个客户端和用户
php bin/console doctrine:fixtures:load
###预配置的供应商模块
- FOSOAuthServerBundle:提供基于OAuth2的令牌和用户授权
- FOSUserBundle:提供用户和组管理
- FOSRestBundle:提供各种工具,以便快速使用Symfony开发RESTful API
- NelmioApiDocBundle:从注释生成REST API的文档
- NelmioCorsBundle:在您的Symfony2应用程序中添加CORS(跨源资源共享)头部支持
- JMSSerializerBundle:允许您轻松地序列化和反序列化任何复杂性的数据
- LiipMonitorBundle:提供监控接口
- DoctrineBundle:提供ORM数据库层
- DoctrineFixturesBundle:提供固定数据,用于初始安装和验收测试加载数据
#文档
API文档显示在api.your-domain.com/doc
下。
#监控
监控运行在api.your-domain.com/monitor/
#单元测试
创建测试数据库
php bin/console doctrine:database:create -e test
使用以下命令运行单元测试:
bin/phpunit
对于验收测试,您需要一个测试数据库。在您的parameters.yml
中设置test_database_name
、test_database_user
和test_database_password
。