Merge branch 'feature/59' into develop

Close #59
Fixes #57
Fixes #58
Fixes #67

Author: weierophinney

CHANGELOG.md

@@ -6,7 +6,7 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Added
 
-- Nothing.
+- [#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) adds the ability to specify examples for fields.
 
 ### Changed
 
@@ -24,7 +24,11 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- Nothing.
+- [#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) provides a fix to configuration detection that removes an emitted
+  notice when no zf-rpc and/or no zf-rest configuration is present.
+
+- [#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) fixes the "api" route parameter constraint to accept `%` characters, which
+  are often present when multi-segment namespaces are used for a given API name.
 
 ## 1.2.3 - 2016-10-11
 

config/module.config.php

@@ -19,7 +19,7 @@
                         'options' => [
                             'route'    => '/documentation[/:api[-v:version][/:service]]',
                             'constraints' => [
-                                'api' => '[a-zA-Z][a-zA-Z0-9_.]+',
+                                'api' => '[a-zA-Z][a-zA-Z0-9_.%]+',
                             ],
                             'defaults' => [
                                 'controller' => Controller::class,

src/ApiFactory.php

@@ -102,10 +102,10 @@ public function createApi($apiName, $apiVersion = 1)
         $api->setName($apiName);
 
         $serviceConfigs = [];
-        if ($this->config['zf-rest']) {
+        if (!empty($this->config['zf-rest'])) {
             $serviceConfigs = array_merge($serviceConfigs, $this->config['zf-rest']);
         }
-        if ($this->config['zf-rpc']) {
+        if (!empty($this->config['zf-rpc'])) {
             $serviceConfigs = array_merge($serviceConfigs, $this->config['zf-rpc']);
         }
 
@@ -407,6 +407,10 @@ private function getField(array $fieldData)
             $field->setFieldType($fieldData['field_type']);
         }
 
+        if (isset($fieldData['example'])) {
+            $field->setExample($fieldData['example']);
+        }
+
         $required = isset($fieldData['required']) ? (bool) $fieldData['required'] : false;
         $field->setRequired($required);
 

src/Field.php

@@ -36,6 +36,11 @@ class Field implements IteratorAggregate
      */
     protected $fieldType = '';
 
+    /**
+     * @var string
+     */
+    protected $example;
+
     /**
      * @param string $name
      */
@@ -116,6 +121,18 @@ public function setFieldType($fieldType)
         $this->fieldType = $fieldType;
     }
 
+    public function getExample()
+    {
+        return $this->example;
+    }
+
+    public function setExample($example)
+    {
+        $this->example = $example;
+
+        return $this;
+    }
+
     /**
      * Cast object to array
      *
@@ -127,6 +144,7 @@ public function toArray()
             'description' => $this->description,
             'required' => $this->required,
             'type' => $this->fieldType,
+            'example' => $this->example,
         ];
     }
 

src/View/AgAcceptHeaders.php

@@ -19,10 +19,15 @@ class AgAcceptHeaders extends AbstractHelper
      */
     public function __invoke(Service $service)
     {
+        $requestAcceptTypes = $service->getRequestAcceptTypes();
+        if (empty($requestAcceptTypes)) {
+            $requestAcceptTypes = [];
+        }
+
         $view = $this->getView();
         $types = array_map(function ($type) use ($view) {
             return sprintf('<div class="list-group-item">%s</div>', $view->escapeHtml($type));
-        }, $service->getRequestAcceptTypes());
+        }, $requestAcceptTypes);
         return implode("\n", $types);
     }
 }

src/View/AgContentTypeHeaders.php

@@ -19,10 +19,15 @@ class AgContentTypeHeaders extends AbstractHelper
      */
     public function __invoke(Service $service)
     {
+        $requestContentTypes = [];
+        if (!empty($service->getRequestContentTypes())) {
+            $requestContentTypes = $service->getRequestContentTypes();
+        }
+
         $view = $this->getView();
         $types = array_map(function ($type) use ($view) {
             return sprintf('<div class="list-group-item">%s</div>', $view->escapeHtml($type));
-        }, $service->getRequestContentTypes());
+        }, $requestContentTypes);
         return implode("\n", $types);
     }
 }