added support collection query string and swagger's summary for servi…

…ce method
reuven770 · Feb 2, 2017 · 023d81e · 023d81e · reuven770 · Feb 2, 2017
1 parent 26cf4e0
commit 023d81e
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 2 deletions.
diff --git a/src/ApiFactory.php b/src/ApiFactory.php
@@ -102,10 +102,10 @@ public function createApi($apiName, $apiVersion = 1)
         $api->setName($apiName);
 
         $serviceConfigs = [];
-        if ($this->config['zf-rest']) {
+        if (isset($this->config['zf-rest']) && !empty($this->config['zf-rest'])) {
             $serviceConfigs = array_merge($serviceConfigs, $this->config['zf-rest']);
         }
-        if ($this->config['zf-rpc']) {
+        if (isset($this->config['zf-rpc']) && !empty($this->config['zf-rpc'])) {
             $serviceConfigs = array_merge($serviceConfigs, $this->config['zf-rpc']);
         }
 
@@ -182,6 +182,9 @@ public function createService(Api $api, $serviceName)
             return false;
         }
 
+        // added service Collection Query String Whitelist
+        $service->setQueryWhitelist ($serviceData["collection_query_whitelist"]);
+
         $authorizations = $this->getAuthorizations($serviceClassName);
 
         $docsArray = $this->getDocumentationConfig($api->getName());
@@ -233,6 +236,12 @@ public function createService(Api $api, $serviceName)
                     : '';
                 $op->setRequestDescription($requestDescription);
 
+                // added support swagger summary option for collection's method
+                $requestSummary = isset($docsArray[$serviceClassName]['collection'][$httpMethod]['summary'])
+                    ? $docsArray[$serviceClassName]['collection'][$httpMethod]['summary']
+                    : '';
+                $op->setSummary($requestSummary)  ;
+
                 $responseDescription = isset($docsArray[$serviceClassName]['collection'][$httpMethod]['response'])
                     ? $docsArray[$serviceClassName]['collection'][$httpMethod]['response']
                     : '';
@@ -303,6 +312,12 @@ public function createService(Api $api, $serviceName)
                     : '';
                 $op->setRequestDescription($requestDescription);
 
+                // add supprt swagger summary option for entity's methods
+                $requestSummary = isset($docsArray[$serviceClassName]['entity'][$httpMethod]['summary'])
+                    ? $docsArray[$serviceClassName]['entity'][$httpMethod]['summary']
+                    : '';
+                $op->setSummary($requestSummary)  ;
+
                 $responseDescription = isset($docsArray[$serviceClassName]['entity'][$httpMethod]['response'])
                     ? $docsArray[$serviceClassName]['entity'][$httpMethod]['response']
                     : '';

diff --git a/src/Operation.php b/src/Operation.php
@@ -45,6 +45,13 @@ class Operation implements IteratorAggregate
      */
     protected $responseStatusCodes = [];
 
+    /**
+     * Possible summary support for swagger
+     *
+     * @var string
+     */
+    protected $summary;
+
     /**
      * @param string $httpMethod
      */
@@ -141,6 +148,22 @@ public function getResponseStatusCodes()
         return $this->responseStatusCodes;
     }
 
+    /**
+     * @param string $summary
+     */
+    public function setSummary($summary)
+    {
+        $this->summary = $summary;
+    }
+
+    /**
+     * @return array
+     */
+    public function getSummary()
+    {
+        return $this->summary;
+    }
+
     /**
      * Cast object to array
      *

diff --git a/src/Service.php b/src/Service.php
@@ -66,6 +66,11 @@ class Service implements IteratorAggregate
      */
     protected $fields = [];
 
+    /**
+     * @var array
+     */
+    protected $queryWhitelist = [];
+
     /**
      * @param \ZF\Apigility\Documentation\Api $api
      */
@@ -242,6 +247,24 @@ public function getFields($type)
         return isset($this->fields[$type]) ? $this->fields[$type] : [];
     }
 
+    /**
+     * @param $queryWhitelist
+     * @return array
+     */
+    public function setQueryWhitelist($queryWhitelist)
+    {
+        return $this->queryWhitelist = $queryWhitelist;
+    }
+
+    /**
+     *
+     * @return array
+     */
+    public function getQueryWhitelist()
+    {
+        return isset($this->queryWhitelist) ? $this->queryWhitelist : [];
+    }
+
     /**
      * Cast object to array
      *