RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 23:59:26 +03:00
Code Issues Projects Releases Wiki Activity

Document serializer groups

Browse Source
This commit is contained in:
Guilhem Niot 2017-06-14 14:28:37 +02:00 committed by GitHub
parent d1761826ab
commit 25c109ab67
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -91,13 +91,15 @@ nelmio_api_doc:
To document your routes, you can use annotations in your controllers:
```php
namespace AppBundle\Controller;
use AppBundle\Entity\User;
use AppBundle\Entity\Reward;
use Nelmio\ApiDocBundle\Annotation\Model;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Swagger\Annotations as SWG;
class DefaultController
class UserController
{
/*
* @Route("/api/{user}/rewards", methods={"GET"})
@ -106,7 +108,7 @@ class DefaultController
* description="Returns the rewards of an user",
* @SWG\Schema(
* type="array",
* @Model(type=Reward::class)
* @Model(type=Reward::class, groups={"full"})
* )
* )
* @SWG\Parameter(
@ -117,7 +119,7 @@ class DefaultController
* )
* @SWG\Tag(name="rewards")
*/
public function indexAction(User $user)
public function fetchUserRewardsAction(User $user)
{
// ...
}