Use ordered output for Swagger specs

tomchristie · tomchristie · commit b9621a91c652 · 2016-09-30T17:05:33.000+01:00
diff --git a/openapi_codec/__init__.py b/openapi_codec/__init__.py
@@ -8,7 +8,7 @@
 from openapi_codec.decode import _parse_document
 
 
-__version__ = '1.1.2'
+__version__ = '1.1.3'
 
 
 class OpenAPICodec(BaseCodec):
diff --git a/openapi_codec/encode.py b/openapi_codec/encode.py
@@ -1,3 +1,4 @@
+from collections import OrderedDict
 from coreapi.compat import urlparse
 from openapi_codec.utils import get_method, get_encoding, get_location, get_links_from_document
 
@@ -8,20 +9,20 @@ def generate_swagger_object(document):
     """
     parsed_url = urlparse.urlparse(document.url)
 
-    swagger = {
-        'swagger': '2.0',
-        'info': {
-            'title': document.title,
-            'version': ''  # Required by the spec
-        },
-        'paths': _get_paths_object(document)
-    }
+    swagger = OrderedDict()
+
+    swagger['swagger'] = '2.0'
+    swagger['info'] = OrderedDict()
+    swagger['info']['title'] = document.title
+    swagger['info']['version'] = ''  # Required by the spec
 
     if parsed_url.netloc:
         swagger['host'] = parsed_url.netloc
     if parsed_url.scheme:
         swagger['schemes'] = [parsed_url.scheme]
 
+    swagger['paths'] = _get_paths_object(document)
+
     return swagger
 
 
@@ -59,7 +60,7 @@ def _get_links(document):
 
 
 def _get_paths_object(document):
-    paths = {}
+    paths = OrderedDict()
 
     links = _get_links(document)
 
diff --git a/openapi_codec/utils.py b/openapi_codec/utils.py
@@ -1,3 +1,15 @@
+def link_sorting_key(link_item):
+    keys, link = link_item
+    action_priority = {
+        '': 0, 'get': 0,
+        'post': 1,
+        'put': 2,
+        'patch': 3,
+        'delete': 4
+    }.get(link.action, 5)
+    return (link.url, action_priority)
+
+
 def get_links_from_document(node, keys=()):
     links = []
     for key, link in getattr(node, 'links', {}).items():
@@ -8,7 +20,7 @@ def get_links_from_document(node, keys=()):
         # Descend into any nested structures.
         index = keys + (key,)
         links.extend(get_links_from_document(child, index))
-    return links
+    return sorted(links, key=link_sorting_key)
 
 
 def get_method(link):
