Merge remote-tracking branch 'api/MAGETWO-53008-swagger-format' into pull-request

Author: Cari Spruiell

app/code/Magento/Webapi/Model/Rest/Swagger/Generator.php

@@ -19,6 +19,7 @@
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\Phrase;
 use Magento\Framework\App\ProductMetadataInterface;
+use \Magento\Framework\Api\SimpleDataObjectConverter;
 
 /**
  * REST Swagger schema generator.
@@ -541,10 +542,52 @@ protected function getDefinitions()
                     ],
                 ],
             ],
-            $this->definitions
+            $this->snakeCaseDefinitions($this->definitions)
         );
     }
 
+    /**
+     * Converts definitions' properties array to snake_case.
+     *
+     * @param array $definitions
+     * @return array
+     */
+    private function snakeCaseDefinitions($definitions)
+    {
+        foreach ($definitions as $name => $vals) {
+            if (!empty($vals['properties'])) {
+                $definitions[$name]['properties'] = $this->convertArrayToSnakeCase($vals['properties']);
+            }
+            if (!empty($vals['required'])) {
+                $snakeCaseRequired = [];
+                foreach ($vals['required'] as $requiredProperty) {
+                    $snakeCaseRequired[] = SimpleDataObjectConverter::camelCaseToSnakeCase($requiredProperty);
+                }
+                $definitions[$name]['required'] = $snakeCaseRequired;
+            }
+        }
+        return $definitions;
+    }
+
+    /**
+     * Converts associative array's key names from camelCase to snake_case, recursively.
+     *
+     * @param array $properties
+     * @return array
+     */
+    private function convertArrayToSnakeCase($properties)
+    {
+        foreach ($properties as $name => $value) {
+            $snakeCaseName = SimpleDataObjectConverter::camelCaseToSnakeCase($name);
+            if (is_array($value)) {
+                $value = $this->convertArrayToSnakeCase($value);
+            }
+            unset($properties[$name]);
+            $properties[$snakeCaseName] = $value;
+        }
+        return $properties;
+    }
+
     /**
      * Get definition reference
      *

dev/tests/api-functional/testsuite/Magento/Webapi/JsonGenerationFromDataObjectTest.php

@@ -240,7 +240,7 @@ public function getExpectedMultiServiceData()
                     'type' => 'object',
                     'description' => 'Interface for custom attribute value.',
                     'properties' => [
-                        'attributeCode' => [
+                        'attribute_code' => [
                             'type' => 'string',
                             'description' => 'Attribute code',
                         ],
@@ -250,15 +250,15 @@ public function getExpectedMultiServiceData()
                         ],
                     ],
                     'required' => [
-                        'attributeCode',
+                        'attribute_code',
                         'value',
                     ],
                 ],
                 'test-module5-v1-entity-all-soap-and-rest' => [
                     'type' => 'object',
                     'description' => 'Some Data Object short description. Data Object long multi line description.',
                     'properties' => [
-                        'entityId' => [
+                        'entity_id' => [
                             'type' => 'integer',
                                 'description' => 'Item ID',
                             ],
@@ -274,7 +274,7 @@ public function getExpectedMultiServiceData()
                                 'type' => 'boolean',
                                 'description' => 'If current entity has a property defined',
                             ],
-                            'customAttributes' =>        [
+                            'custom_attributes' =>        [
                             'type' => 'array',
                             'description' => 'Custom attributes values.',
                             'items' => [
@@ -283,7 +283,7 @@ public function getExpectedMultiServiceData()
                         ],
                     ],
                     'required' => [
-                        'entityId',
+                        'entity_id',
                         'enabled',
                         'orders',
                     ],