feat: ensuring that exported definitions are sorted by path and method (

#225)
readmeio · Nov 4, 2021 · c272295 · c272295
1 parent df3a24d
commit c272295
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 40 deletions.
diff --git a/__tests__/__fixtures__/project-openapi/api.js b/__tests__/__fixtures__/project-openapi/api.js
@@ -1,3 +1,35 @@
+/*
+ * @api [post] /pets
+ *    description: "Creates a new pet in the store. Duplicates are allowed"
+ *    operationId: "addPet"
+ *    requestBody:
+ *      description: "Pet to add to the store"
+ *      required: true
+ *      content:
+ *        application/json:
+ *          schema:
+ *            $ref: "#/components/schemas/Pet"
+ *    responses:
+ *      "200":
+ *        description: "pet response"
+ *        content:
+ *          application/json:
+ *            schema:
+ *              type: "array"
+ *              items:
+ *                $ref: "#/components/schemas/Pet"
+ *      default:
+ *        description: "unexpected error"
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: "#/components/schemas/ErrorModel"
+ */
+
+router.post('/pets', () => {
+
+});
+
 /*
  * @api [get] /pets
  *    description: "Returns all pets from the system that the user has access to"
@@ -42,38 +74,6 @@ router.get('/pets', () => {
 
 });
 
-/*
- * @api [post] /pets
- *    description: "Creates a new pet in the store. Duplicates are allowed"
- *    operationId: "addPet"
- *    requestBody:
- *      description: "Pet to add to the store"
- *      required: true
- *      content:
- *        application/json:
- *          schema:
- *            $ref: "#/components/schemas/Pet"
- *    responses:
- *      "200":
- *        description: "pet response"
- *        content:
- *          application/json:
- *            schema:
- *              type: "array"
- *              items:
- *                $ref: "#/components/schemas/Pet"
- *      default:
- *        description: "unexpected error"
- *        content:
- *          application/json:
- *            schema:
- *              $ref: "#/components/schemas/ErrorModel"
- */
-
-router.post('/pets', () => {
-
-});
-
 /*
  * @api [get] /pets/{id}
  *    description: "Returns a user based on a single ID, if the user does not have access to the pet"

diff --git a/package-lock.json b/package-lock.json
diff --git a/src/index.js b/src/index.js
@@ -12,7 +12,20 @@ function outputResult(object, options) {
   });
 }
 
+function sortObj(obj, compare) {
+  const sorted = compare ? Object.keys(obj).sort(compare) : Object.keys(obj);
+  return sorted.reduce(function (result, key) {
+    // eslint-disable-next-line no-param-reassign
+    result[key] = obj[key];
+    return result;
+  }, {});
+}
+
 function mergeEndpointsWithBase(swaggerBase = {}, endpoints = []) {
+  // To ensure consistent sorting of HTTP methods let's universally enforce the following order.
+  const methodPriority = new Map();
+  ['get', 'post', 'put', 'patch', 'delete', 'options', 'head', 'trace'].forEach((x, i) => methodPriority.set(x, i));
+
   return endpoints.reduce((prev, current) => {
     const { method, route, ...operation } = current;
     if (!method || !route) {
@@ -24,6 +37,12 @@ function mergeEndpointsWithBase(swaggerBase = {}, endpoints = []) {
     if (!prev.paths[route]) prev.paths[route] = {};
 
     prev.paths[route][method] = operation;
+
+    // Resort everything to be alphabetical.
+    prev.paths = sortObj(prev.paths);
+    prev.paths[route] = sortObj(prev.paths[route], (a, b) => {
+      return methodPriority.get(a) - methodPriority.get(b);
+    });
     /* eslint-enable no-param-reassign */
 
     return prev;
@@ -42,6 +61,7 @@ function mergeSchemasWithBase(swaggerBase = {}, schemas = []) {
     if (!prev.components.schemas) prev.components.schemas = {};
 
     prev.components.schemas[name] = schema;
+    prev.components.schemas = sortObj(prev.components.schemas);
     /* eslint-enable no-param-reassign */
 
     return prev;