@sleeksky/alt-swagger 2.1.0 → 2.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sleeksky/alt-swagger",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "Quickly spec your APIs for Swagger / OpenAPI interface",
   "main": "./src/index.js",
   "scripts": {

package/src/index.js

@@ -3,7 +3,7 @@
  */
 require("./utils");
 const _ = require("lodash");
-const { toSwaggerSchema, pathParameters, toParameter} = require("./utils")
+const { toSwaggerSchema, pathParameters, pathClean, toParameter} = require("./utils")
 
 const paths = {};
 const components = {};
@@ -26,7 +26,7 @@ function api(opt) {
   const pathParams = pathParameters(opt.path);
   if (pathParams.length > 0) spec.parameters = pathParams;
 
-  _.set(paths, `${opt.path}.${opt.method}`, spec);
+  _.set(paths, `${pathClean(opt.path)}.${opt.method}`, spec);
 
   let ext = {};
 
@@ -121,9 +121,9 @@ function tag(name, description) {
   tags.push({ name, description });
 }
 
-function swaggerDoc(title = "API Docs") {
+function swaggerDoc(title) {
   return {
-    info: { title, version: "1.0.0" },
+    info: { title: title || "", version: "1.0.0" },
     openapi: "3.0.0",
     servers,
     tags,

package/src/utils.js

@@ -12,6 +12,10 @@ const RX_NESTED = /^\:?(\$[0-9]+)$/;
 const RX_FLAT_ARR = /^\[([^\{\}\[\]]+)\]$/;
 const RX_FLAT_OBJ = /^\{([^\{\}\[\]]+)\}$/;
 
+const RX_BRACE = /\{([^\}]+)\}/g;
+const RX_COLON = /\:([^\/]+)/g;
+
+
 function toSwaggerSchema(str) {
 
   function traverse(schema, obj) {
@@ -34,9 +38,9 @@ function toSwaggerSchema(str) {
       if (def !== '') {
         if (type === 'number' || type === 'integer') def = def*1;
         if (type === 'boolean') def = ['true','1'].indexOf(def) > -1 ? true : false;
-        schema.default = def;
+        schema.example = def;
       } else if (optional) {
-        schema.default = null;
+        // schema.default = null;
       }
       if (!optional) schema.required = true;
     }
@@ -54,19 +58,23 @@ function toSwaggerSchema(str) {
 
 function pathParameters(str) {
   let params = [];
-  const RX_BRACE = /\{([^\}]+)\}/g;
-  const RX_COLON = /\:([^\/]+)/g;
   let matches = str.match(RX_BRACE);
   if (!matches) matches = str.match(RX_COLON);
   if (matches) {
     params = matches.map(m => {
-      let p = m.replace(/[\{\}\:]/g, "");
-      return { in: "path", name: p, schema: { type: "string" }, required: true };
+      let [p, def] = m.replace(/^[\{\:]/,"").replace(/[\}]$/,"").split(":");
+      if (!def) def = "";
+      return { in: "path", name: p, schema: { type: "string", example: def }, required: true };
     });
   }
   return params;
 }
 
+function pathClean(path) {
+  if (path.match(RX_BRACE)) return path.replace(RX_BRACE, m => `${m.split(":")[0]}}`)
+  return path;
+}
+
 // header:?token
 function toParameter(inType, str) {
   if (!_.isString(str)) return str;
@@ -90,4 +98,4 @@ function toParameter(inType, str) {
   }
 }
 
-module.exports = {toSwaggerSchema, pathParameters, toParameter};
+module.exports = {toSwaggerSchema, pathParameters, pathClean, toParameter};