apib2swagger 1.13.0 → 1.14.2

package/README.md

@@ -1,10 +1,10 @@
 # apib2swagger
 
-[![Build Status](https://travis-ci.org/kminami/apib2swagger.svg?branch=master)](https://travis-ci.org/kminami/apib2swagger)
+![Build Status](https://github.com/kminami/apib2swagger/actions/workflows/nodejs.yml/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/kminami/apib2swagger/badge.svg?branch=master)](https://coveralls.io/github/kminami/apib2swagger?branch=master)
 [![npm version](https://badge.fury.io/js/apib2swagger.svg)](https://badge.fury.io/js/apib2swagger)
 
-Convert [API Blueprint][] to [Swagger][].
+Convert [API Blueprint](https://apiblueprint.org/) to [Swagger 2.0](http://swagger.io/) or [OpenAPI 3.0](https://github.com/OAI/OpenAPI-Specification).
 
 Supported versions:
 - API Blueprint 1A9
@@ -91,16 +91,11 @@ cat api.md | npx apib2swagger > swagger.json
 You can also run apib2swagger inside a docker container.
 
 ```bash
-$ docker run -it --rm -v $(pwd):/docs kminami/apib2swagger -i /docs/api.md -o /docs/swagger.json
+$ docker run -it --rm -v $(pwd):/docs ghcr.io/kminami/apib2swagger -i /docs/api.md -o /docs/swagger.json
 ```
 
-You can use container images in GitHub Container Registory like `ghcr.io/kminami/apib2swagger` or `ghcr.io/kminami/apib2swagger:1.12.0` instead of Docker Hub.
-
 ## License
 
 Copyright (c) 2021 Keisuke Minami
 
 MIT
-
-[API Blueprint]: https://apiblueprint.org/ "API Blueprint"
-[Swagger]: http://swagger.io/ "Swagger"

package/bin/apib2swagger.js

@@ -111,6 +111,12 @@ function processBlueprint(blueprint, opts) {
     };
     apib2swagger.convert(blueprint, options, function(error, result) {
         if (error) {
+            if (error.stack && error.result) {
+                // override toString() of drafter's error to expand error.result.error.location
+                console.log(error.stack);
+                console.log(JSON.stringify(error.result, 0, 2));
+                return;
+            }
             console.log(error);
             return;
         }
@@ -126,7 +132,7 @@ function processBlueprint(blueprint, opts) {
             return runServer(swagger);
         }
         if (opts.yaml) {
-            var data = yaml.safeDump(swagger);
+            var data = yaml.dump(swagger);
             if (output !== '-') {
                 fs.writeFileSync(output, data);
             } else {

package/index.js

@@ -7,6 +7,7 @@ const { searchDataStructure, generateSchemaFromExample } = require('./src/util')
 const { processRequests } = require('./src/requests')
 const { processResponses } = require('./src/responses')
 const { processParameters } = require('./src/parameters')
+const toOpenApi = require('json-schema-to-openapi-schema')
 
 var apib2swagger = module.exports.convertParsed = function (apib, options) {
     const { openApi3, infoTitle } = options
@@ -75,7 +76,7 @@ var apib2swagger = module.exports.convertParsed = function (apib, options) {
                 const { id } = content.content[0].meta
                 const schema = jsonSchemaFromMSON(content, options);
                 if (openApi3) {
-                    output.components.schemas[id] = schema
+                    output.components.schemas[id] = toOpenApi(schema)
                 } else {
                     output.definitions[id] = schema
                 }
@@ -111,7 +112,7 @@ var swaggerDefinitions = function (resource, options) {
         scheme = searchDataStructure(resource.content, options); // Attributes 1
         if (openApi3) {
             if (scheme) {
-                result[resource.name] = scheme
+                result[resource.name] = toOpenApi(scheme)
             }
         } else {
             result[resource.name] = scheme ? scheme : {};
@@ -126,7 +127,7 @@ var swaggerDefinitions = function (resource, options) {
         }
         if (openApi3) {
             if (scheme) {
-                result[model.name + 'Model'] = scheme
+                result[model.name + 'Model'] = toOpenApi(scheme)
             }
         } else {
             result[model.name + 'Model'] = scheme ? scheme : {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apib2swagger",
-  "version": "1.13.0",
+  "version": "1.14.2",
   "description": "Convert API Blueprint to Swagger.",
   "bin": "./bin/apib2swagger.js",
   "scripts": {
@@ -20,7 +20,8 @@
     "apib-include-directive": "^0.1.0",
     "drafter.js": "^2.6.2",
     "generate-schema": "^2.5.0",
-    "js-yaml": "^3.13.1",
+    "js-yaml": "^4.1.0",
+    "json-schema-to-openapi-schema": "^0.4.0",
     "lodash.isequal": "^4.5.0",
     "nopt": "^3.0.6",
     "uritemplate": "^0.3.4"

package/src/requests.js

@@ -1,6 +1,7 @@
 const { hasFileRef, getRefFromInclude, searchDataStructure, generateSchemaFromExample } = require('./util')
 const isEqual = require('lodash.isequal')
 const escapeJSONPointer = require('./escape_json_pointer')
+const toOpenApi = require('json-schema-to-openapi-schema')
 
 const swaggerHeaders = function (options, headers) {
     var params = [];
@@ -250,8 +251,14 @@ const setOpenApiRequestSchema = (operation, schema) => {
         if (!operation.requestBody.content[schema[0].contentType]){
             operation.requestBody.content[schema[0].contentType] = schema[0].scheme 
         } else {
-            operation.requestBody.content[schema[0].contentType].schema = schema[0].scheme 
+            operation.requestBody.content[schema[0].contentType].schema = schema[0].scheme
         }
+        Object.keys(operation.requestBody.content).forEach(contentType => {
+            const s = operation.requestBody.content[contentType].schema;
+            if (s) {
+                operation.requestBody.content[contentType].schema = toOpenApi(s)
+            }
+        })
         return operation
     } 
 
@@ -283,6 +290,12 @@ const setOpenApiRequestSchema = (operation, schema) => {
             ]
         }
     })
+    Object.keys(operation.requestBody.content).forEach(contentType => {
+        const s = operation.requestBody.content[contentType].schema;
+        if (s) {
+            operation.requestBody.content[contentType].schema = toOpenApi(s)
+        }
+    })
     return operation
 }
 

package/src/responses.js

@@ -2,6 +2,7 @@ const { fixArraySchema, hasFileRef, getRefFromInclude, searchDataStructure } = r
 const escapeJSONPointer = require('./escape_json_pointer')
 const isEqual = require('lodash.isequal')
 const http = require('http')
+const toOpenApi = require('json-schema-to-openapi-schema')
 
 const parseResponseSchema = (schema, options) => {
     if (!schema) return
@@ -64,6 +65,10 @@ const setResponseSchema = (responses, response, schema, options) => {
         responses[response.name].schema = schema
         return responses
     }
+    // Convert JSON Schema draft04 to OpenAPI 3.0.x (type: null -> nullable: true)
+    // TODO: Skip this for OpenAPI 3.1.x or later.
+    schema = toOpenApi(schema)
+
     // In openAPI 3 the schema lives under the content type
     const contentTypeHeader = response.headers.find((h) => h.name.toLowerCase() === 'content-type')
     if (!contentTypeHeader.value) {

package/src/util.js

@@ -87,10 +87,8 @@ module.exports.generateSchemaFromExample = function (headers, example, options)
         delete scheme.$schema;
         // if we have example values in the body then insert them into the json schema
         if (!options.openApi3) {
-            if (scheme['type'] === 'object') {
+            if (scheme['type'] === 'object' || scheme['type'] === 'array') {
                 scheme.example = body;
-            } else if (scheme['type'] === 'array') {
-                scheme.items.example = body;
             }
         }
         return scheme;

package/test/input/Issue-#57.md

@@ -0,0 +1,14 @@
+# DELETE /domains
+
++ Request (application/json)
+
+  Domain deletes are limited to 10,000 domains per request.
+
+    + Body
+
+            [
+                "example1.com",
+                "example2.com"
+            ]
+
++ Response 204 (application/json)

package/test/input/OpenAPI3_Issue-#58.md

@@ -0,0 +1,31 @@
+# Group Users
+
+## A user [/user]
+
+### Get one user [GET]
++ Response 200 (application/json)
+  + Attributes (User)
++ Response 500 (application/json)
+
+## Some users [/users]
+
+### Post a user [POST]
++ Request (application/json)
+  + Attributes(User)
++ Response 201 (application/json)
+  + Attributes (User)
++ Response 500 (application/json)
+
+### Get a collection of users [GET]
++ Response 200 (application/json)
+  + Attributes (array[User])
++ Response 500 (application/json)
+
+# Data Structures
+
+## User (object)
++ id (string, required)
++ name (string, nullable, required)
+
+## Users (object)
++ `users`(array[User], nullable, required)

package/test/output/Issue-#57.json

@@ -0,0 +1,44 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "",
+    "version": "",
+    "description": ""
+  },
+  "paths": {
+    "/domains": {
+      "delete": {
+        "responses": {
+          "204": {
+            "description": "No Content",
+            "headers": {},
+            "examples": {}
+          }
+        },
+        "summary": "",
+        "operationId": "",
+        "description": "",
+        "tags": [],
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "example": [
+                "example1.com",
+                "example2.com"
+              ]
+            }
+          }
+        ]
+      }
+    }
+  },
+  "definitions": {},
+  "securityDefinitions": {},
+  "tags": []
+}

package/test/output/Issue-#57.ref.json

@@ -0,0 +1,44 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "",
+    "version": "",
+    "description": ""
+  },
+  "paths": {
+    "/domains": {
+      "delete": {
+        "responses": {
+          "204": {
+            "description": "No Content",
+            "headers": {},
+            "examples": {}
+          }
+        },
+        "summary": "",
+        "operationId": "",
+        "description": "",
+        "tags": [],
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "example": [
+                "example1.com",
+                "example2.com"
+              ]
+            }
+          }
+        ]
+      }
+    }
+  },
+  "definitions": {},
+  "securityDefinitions": {},
+  "tags": []
+}

package/test/output/OpenAPI3_Issue-#58.json

@@ -0,0 +1,202 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "",
+    "version": "1.0.0",
+    "description": ""
+  },
+  "paths": {
+    "/user": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {},
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string"
+                    },
+                    "name": {
+                      "type": "string",
+                      "nullable": true
+                    }
+                  },
+                  "required": [
+                    "id",
+                    "name"
+                  ]
+                },
+                "example": {
+                  "id": "",
+                  "name": null
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {}
+          }
+        },
+        "summary": "Get one user",
+        "operationId": "Get one user",
+        "description": "",
+        "tags": [
+          "Users"
+        ],
+        "parameters": []
+      }
+    },
+    "/users": {
+      "post": {
+        "responses": {
+          "201": {
+            "description": "Created",
+            "headers": {},
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string"
+                    },
+                    "name": {
+                      "type": "string",
+                      "nullable": true
+                    }
+                  },
+                  "required": [
+                    "id",
+                    "name"
+                  ]
+                },
+                "example": {
+                  "id": "",
+                  "name": null
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {}
+          }
+        },
+        "summary": "Post a user",
+        "operationId": "Post a user",
+        "description": "",
+        "tags": [
+          "Users"
+        ],
+        "parameters": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "example": {
+                "id": "",
+                "name": null
+              },
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "name": {
+                    "type": "string",
+                    "nullable": true
+                  }
+                },
+                "required": [
+                  "id",
+                  "name"
+                ]
+              }
+            }
+          }
+        }
+      },
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {},
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {}
+                },
+                "example": [
+                  {
+                    "id": "",
+                    "name": null
+                  }
+                ]
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {}
+          }
+        },
+        "summary": "Get a collection of users",
+        "operationId": "Get a collection of users",
+        "description": "",
+        "tags": [
+          "Users"
+        ],
+        "parameters": []
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "User": {
+        "type": "object",
+        "required": [
+          "id",
+          "name"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      },
+      "Users": {
+        "type": "object",
+        "required": [
+          "users"
+        ],
+        "properties": {
+          "users": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/User"
+            },
+            "nullable": true
+          }
+        }
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "Users"
+    }
+  ]
+}

package/test/output/OpenAPI3_Issue-#58.ref.json

@@ -0,0 +1,163 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "",
+    "version": "1.0.0",
+    "description": ""
+  },
+  "paths": {
+    "/user": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {},
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/User"
+                },
+                "example": {
+                  "id": "",
+                  "name": null
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {}
+          }
+        },
+        "summary": "Get one user",
+        "operationId": "Get one user",
+        "description": "",
+        "tags": [
+          "Users"
+        ],
+        "parameters": []
+      }
+    },
+    "/users": {
+      "post": {
+        "responses": {
+          "201": {
+            "description": "Created",
+            "headers": {},
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/User"
+                },
+                "example": {
+                  "id": "",
+                  "name": null
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {}
+          }
+        },
+        "summary": "Post a user",
+        "operationId": "Post a user",
+        "description": "",
+        "tags": [
+          "Users"
+        ],
+        "parameters": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "example": {
+                "id": "",
+                "name": null
+              },
+              "schema": {
+                "$ref": "#/components/schemas/User"
+              }
+            }
+          }
+        }
+      },
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {},
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {}
+                },
+                "example": [
+                  {
+                    "id": "",
+                    "name": null
+                  }
+                ]
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {}
+          }
+        },
+        "summary": "Get a collection of users",
+        "operationId": "Get a collection of users",
+        "description": "",
+        "tags": [
+          "Users"
+        ],
+        "parameters": []
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "User": {
+        "type": "object",
+        "required": [
+          "id",
+          "name"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      },
+      "Users": {
+        "type": "object",
+        "required": [
+          "users"
+        ],
+        "properties": {
+          "users": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/User"
+            },
+            "nullable": true
+          }
+        }
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "Users"
+    }
+  ]
+}

package/test/test.js

@@ -46,6 +46,7 @@ var remote = 'https://raw.githubusercontent.com/apiaryio/api-blueprint/format-1A
         'Issue-#36.md',
         'Issue-#38.md',
         'Issue-#49.md',
+        'Issue-#57.md',
         'apiblueprint_uber.md',
         'apiblueprint_valid_simple.md',
         'schema_without_body.md',
@@ -53,7 +54,8 @@ var remote = 'https://raw.githubusercontent.com/apiaryio/api-blueprint/format-1A
         'OpenAPI3_requests.md',
         'OpenAPI3_headers.md',
         'OpenAPI3_includes.md',
-        'OpenAPI3_attributes.md'
+        'OpenAPI3_attributes.md',
+        'OpenAPI3_Issue-#58.md'
     ];
 
 var fetch = function (file) {