From 25c109ab677f34ae879f562afc5635cdd86596a6 Mon Sep 17 00:00:00 2001 From: Guilhem Niot Date: Wed, 14 Jun 2017 14:28:37 +0200 Subject: [PATCH] Document serializer groups --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a480ea7..ac7655c 100644 --- a/README.md +++ b/README.md @@ -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) { // ... }