Implement simple way to alter base uri resolving. (#30)

Author: koemeet

DependencyInjection/Configuration.php

@@ -23,7 +23,8 @@ public function getConfigTreeBuilder()
 
         $rootNode
             ->children()
-                ->booleanNode('show_version_info')->defaultValue(true)->end()
+            ->booleanNode('show_version_info')->defaultValue(true)->end()
+            ->scalarNode('base_uri')->defaultValue('/api')->end()
             ->end()
         ;
 

DependencyInjection/MangoJsonApiExtension.php

@@ -53,5 +53,6 @@ public function load(array $configs, ContainerBuilder $container)
         }
 
         $container->setParameter('json_api.show_version_info', $config['show_version_info']);
+        $container->setParameter('json_api.base_uri', $config['base_uri']);
     }
 }

EventListener/Serializer/JsonEventSubscriber.php

@@ -17,9 +17,9 @@
 use JMS\Serializer\EventDispatcher\EventSubscriberInterface;
 use JMS\Serializer\EventDispatcher\ObjectEvent;
 use JMS\Serializer\Naming\PropertyNamingStrategyInterface;
-use JMS\Serializer\VisitorInterface;
 use Mango\Bundle\JsonApiBundle\Configuration\Metadata\ClassMetadata;
 use Mango\Bundle\JsonApiBundle\Configuration\Relationship;
+use Mango\Bundle\JsonApiBundle\Resolver\BaseUri\BaseUriResolverInterface;
 use Mango\Bundle\JsonApiBundle\Serializer\JsonApiSerializationVisitor;
 use Metadata\MetadataFactoryInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
@@ -64,7 +64,10 @@ class JsonEventSubscriber implements EventSubscriberInterface
      */
     protected $currentPath;
 
-    protected $baseUrl = '/api';
+    /**
+     * @var BaseUriResolverInterface
+     */
+    protected $baseUriResolver;
 
     /**
      * @param MetadataFactoryInterface        $jsonApiMetadataFactory
@@ -76,12 +79,14 @@ public function __construct(
         MetadataFactoryInterface $jsonApiMetadataFactory,
         MetadataFactoryInterface $jmsMetadataFactory,
         PropertyNamingStrategyInterface $namingStrategy,
-        RequestStack $requestStack
+        RequestStack $requestStack,
+        BaseUriResolverInterface $baseUriResolver
     ) {
         $this->jsonApiMetadataFactory = $jsonApiMetadataFactory;
         $this->jmsMetadataFactory = $jmsMetadataFactory;
         $this->namingStrategy = $namingStrategy;
         $this->requestStack = $requestStack;
+        $this->baseUriResolver = $baseUriResolver;
     }
 
     /**
@@ -190,7 +195,7 @@ public function onPostSerialize(ObjectEvent $event)
             // TODO: Improve link handling
             if (true === $metadata->getResource()->getShowLinkSelf()) {
                 $visitor->addData('links', array(
-                    'self' => $this->baseUrl.'/'.$metadata->getResource()
+                    'self' => $this->baseUriResolver->getBaseUri().'/'.$metadata->getResource()
                             ->getType($object).'/'.$this->getId($metadata, $object),
                 ));
             }
@@ -216,12 +221,12 @@ protected function processRelationshipLinks($primaryObject, Relationship $relati
 
         // TODO: Improve this
         if ($relationship->getShowLinkSelf()) {
-            $links['self'] = $this->baseUrl.'/'.$primaryMetadata->getResource()
+            $links['self'] = $this->baseUriResolver->getBaseUri().'/'.$primaryMetadata->getResource()
                     ->getType($primaryObject).'/'.$primaryId.'/relationships/'.$relationshipPayloadKey;
         }
 
         if ($relationship->getShowLinkRelated()) {
-            $links['related'] = $this->baseUrl.'/'.$primaryMetadata->getResource()->getType($primaryObject).'/'.$primaryId.'/'.$relationshipPayloadKey;
+            $links['related'] = $this->baseUriResolver->getBaseUri().'/'.$primaryMetadata->getResource()->getType($primaryObject).'/'.$primaryId.'/'.$relationshipPayloadKey;
         }
 
         return $links;

README.md

@@ -11,6 +11,13 @@ Integration of JSON API with Symfony 2 (FOSRestBundle)
 
 If you want to experiment with this implementation, you can just enable this bundle in your `AppKernel` and everything should work directly. Try to serialize some annotated php classes and check it out!
 
+### Configuration reference
+```yml
+mango_json_api:
+    show_version_info: true # default
+    base_uri: /api # default
+```
+
 ## Annotations
 ### @Resource
 This will define your class as a JSON-API resource, and you can optionally set it's type name.

Resolver/BaseUri/BaseUriResolver.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * (c) Steffen Brem
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Mango\Bundle\JsonApiBundle\Resolver\BaseUri;
+
+/**
+ * @author Steffen Brem <steffenbrem@gmail.com>
+ */
+class BaseUriResolver implements BaseUriResolverInterface
+{
+    /**
+     * @var string
+     */
+    private $baseUri;
+
+    /**
+     * @param string $baseUri
+     */
+    public function __construct($baseUri)
+    {
+        $this->baseUri = $baseUri;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getBaseUri()
+    {
+        return $this->baseUri;
+    }
+}

Resolver/BaseUri/BaseUriResolverInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * (c) Steffen Brem
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Mango\Bundle\JsonApiBundle\Resolver\BaseUri;
+
+/**
+ * @author Steffen Brem <steffenbrem@gmail.com>
+ */
+interface BaseUriResolverInterface
+{
+    /**
+     * @return string
+     */
+    public function getBaseUri();
+}

Resources/config/services.xml

@@ -15,6 +15,7 @@
             <argument type="service" id="jms_serializer.metadata_factory"/>
             <argument type="service" id="jms_serializer.naming_strategy"/>
             <argument type="service" id="request_stack"/>
+            <argument type="service" id="json_api.resolver.base_uri"/>
             <tag name="jms_serializer.event_subscriber"/>
         </service>
 
@@ -37,6 +38,10 @@
             <tag name="jms_serializer.subscribing_handler"/>
         </service>
 
+        <service id="json_api.resolver.base_uri" alias="json_api.resolver.base_uri.default"/>
+        <service id="json_api.resolver.base_uri.default" class="Mango\Bundle\JsonApiBundle\Resolver\BaseUri\BaseUriResolver">
+            <argument>%json_api.base_uri%</argument>
+        </service>
     </services>
 
 </container>