@sleeksky/alt-swagger 2.0.0 → 2.2.0

package/README.md

@@ -15,6 +15,10 @@ npm install -s @sleeksky/alt-swagger
 
 const docs = require('@sleeksky/alt-swagger');
 
+# Usage
+
+See example.js
+
 # License
 
 MIT © SleekSky

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sleeksky/alt-swagger",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "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 = {};
 

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) {
@@ -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;
@@ -80,7 +88,7 @@ function toParameter(inType, str) {
   if (type && TYPES[type]) type = TYPES[type];
   else type = "string";
   let schema = { type };
-  if (def) schema.default = def;
+  if (def) schema.example = def;
 
   return {
     name,
@@ -90,4 +98,4 @@ function toParameter(inType, str) {
   }
 }
 
-module.exports = {toSwaggerSchema, pathParameters, toParameter};
+module.exports = {toSwaggerSchema, pathParameters, pathClean, toParameter};