provided option to sort endpoints by method

Author: mrin9

docs/api.html

@@ -87,6 +87,11 @@ <h2> Attributes</h2>
             <td class="gray"><span class='bold dark-gray'>Allowed:<span class='blue'> true, false</span></span> To list APIs sorted by tags</td>
             <td class='default-col'>false</td>
           </tr>
+          <tr>
+            <td class="attr-col mono bold right">sort-endpoints-by </td>
+            <td class="gray"><span class='bold dark-gray'>Allowed:<span class='blue'> path, method</span></span> Sort endpoints within each tags by path or method </td>
+            <td class='default-col'>path</td>
+          </tr>
           <tr>
             <td class="mono bold right">heading-text </td>
             <td class="gray">Heading Text on top-left corner </td>

package.json

@@ -32,21 +32,13 @@
     "lit-element": "2.2.1",
     "lit-html": "1.0.0",
     "marked": "^0.8.0",
-<<<<<<< HEAD
-    "snyk": "^1.278.0",
     "swagger2openapi": "^5.3.2"
-=======
-    "swagger2openapi": "^5.3.2",
-    "snyk": "^1.278.2"
->>>>>>> 8e79a50b5783960d72b314a10590f8bd5e97908e
   },
   "scripts": {
     "build": "NODE_ENV=production webpack",
     "serve": "webpack-dev-server --mode=development",
     "lint": "./node_modules/eslint/bin/eslint.js ./src/**",
-    "lint-fix": "./node_modules/eslint/bin/eslint.js --fix ./src/**",
-    "snyk-protect": "snyk protect",
-    "prepare": "yarn run snyk-protect"
+    "lint-fix": "./node_modules/eslint/bin/eslint.js --fix ./src/**"
   },
   "devDependencies": {
     "@babel/core": "^7.8.0",
@@ -73,5 +65,5 @@
     "webpack-cli": "^3.3.10",
     "webpack-dev-server": "^3.10.1"
   },
-  "snyk": true
+  "snyk": false
 }

src/rapidoc.js

@@ -38,6 +38,7 @@ export default class RapiDoc extends LitElement {
       // Spec
       specUrl: { type: String, attribute: 'spec-url' },
       sortTags: { type: String, attribute: 'sort-tags' },
+      sortEndpointsBy: { type: String, attribute: 'sort-endpoints-by' },
       specFile: { type: String, attribute: false },
 
       // UI Layouts
@@ -100,6 +101,7 @@ export default class RapiDoc extends LitElement {
     if (!this.apiKeyName) { this.apiKeyName = ''; }
     if (!this.apiKeyValue) { this.apiKeyValue = ''; }
     if (!this.sortTags || !'true false'.includes(this.sortTags)) { this.sortTags = 'false'; }
+    if (!this.sortEndpointsBy || !'method path'.includes(this.sortEndpointsBy)) { this.sortEndpointsBy = 'path'; }
   }
 
   // Cleanup
@@ -684,6 +686,7 @@ export default class RapiDoc extends LitElement {
       const spec = await ProcessSpec(
         specUrl,
         this.sortTags === 'true',
+        this.getAttribute('sort-endpoints-by'),
         this.getAttribute('api-key-name'),
         this.getAttribute('api-key-location'),
         this.getAttribute('api-key-value'),

src/utils/spec-parser.js

@@ -2,7 +2,7 @@
 import JsonRefs from 'json-refs';
 import converter from 'swagger2openapi';
 
-export default async function ProcessSpec(specUrl, sortTags = false, attrApiKey = '', attrApiKeyLocation = '', attrApiKeyValue = '') {
+export default async function ProcessSpec(specUrl, sortTags = false, sortEndpointsBy, attrApiKey = '', attrApiKeyLocation = '', attrApiKeyValue = '') {
   let jsonParsedSpec;
   let convertedSpec;
   let resolvedRefSpec;
@@ -42,7 +42,7 @@ export default async function ProcessSpec(specUrl, sortTags = false, attrApiKey
   // const pathGroups = groupByPaths(jsonParsedSpec);
 
   // Tags
-  const tags = groupByTags(jsonParsedSpec, sortTags);
+  const tags = groupByTags(jsonParsedSpec, sortTags, sortEndpointsBy);
 
   // Security Scheme
   const securitySchemes = [];
@@ -125,8 +125,8 @@ function groupByPaths(openApiSpec) {
 }
 */
 
-function groupByTags(openApiSpec, sortTags = false) {
-  const methods = ['get', 'put', 'post', 'delete', 'patch', 'head'];
+function groupByTags(openApiSpec, sortTags = false, sortEndpointsBy) {
+  const methods = ['get', 'put', 'post', 'delete', 'patch', 'head']; // this is also used for ordering endpoints by methods
   const tags = openApiSpec.tags && Array.isArray(openApiSpec.tags)
     ? openApiSpec.tags.map((v) => ({
       show: true,
@@ -242,12 +242,21 @@ function groupByTags(openApiSpec, sortTags = false) {
     }); // End of Methods
   }
 
-  // sort paths within each tags;
+  // sort paths by methods or path within each tags;
   const tagsWithSortedPaths = tags.filter((v) => v.paths && v.paths.length > 0);
-  tagsWithSortedPaths.forEach((v) => {
-    if (v.paths) {
-      v.paths.sort((a, b) => (a.path < b.path ? -1 : (a.path > b.path ? 1 : 0)));
-    }
-  });
-  return sortTags ? tagsWithSortedPaths.sort((a, b) => (a.name < b.name ? -1 : (a.name > b.name ? 1 : 0))) : tagsWithSortedPaths;
+  if (sortEndpointsBy === 'method') {
+    tagsWithSortedPaths.forEach((v) => {
+      if (v.paths) {
+        // v.paths.sort((a, b) => a.method.localeCompare(b.method));
+        v.paths.sort((a, b) => methods.indexOf(a.method).toString().localeCompare(methods.indexOf(b.method)));
+      }
+    });
+  } else {
+    tagsWithSortedPaths.forEach((v) => {
+      if (v.paths) {
+        v.paths.sort((a, b) => a.path.localeCompare(b.path));
+      }
+    });
+  }
+  return sortTags ? tagsWithSortedPaths.sort((a, b) => a.name.localeCompare(b.name)) : tagsWithSortedPaths;
 }