apib2swagger 1.12.0 → 1.13.0

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+name: "CodeQL"
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [master]
+  schedule:
+    - cron: '0 13 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # Override automatic language detection by changing the below list
+        # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
+        language: ['javascript']
+        # Learn more...
+        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file. 
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

package/.github/workflows/docker-publish.yml

@@ -67,4 +67,4 @@ jobs:
           echo IMAGE_ID=$IMAGE_ID
           echo VERSION=$VERSION
           docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
-          docker push $IMAGE_ID:$VERSION
+          docker push $IMAGE_ID:$VERSION

package/.github/workflows/nodejs.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x]
+        node-version: [12.x, 14.x, 16.x]
 
     steps:
     - uses: actions/checkout@v1

package/.travis.yml

@@ -1,5 +1,6 @@
 language: node_js
 node_js:
+  - "16"
+  - "14"
   - "12"
-  - "10"
 after_success: npm run coverage

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:10-alpine
+FROM node:16-alpine
 
 RUN npm install -g apib2swagger
 

package/README.md

@@ -13,7 +13,8 @@ Supported versions:
         - VERSION -> .info.version
     - [Include directive](https://github.com/danielgtaylor/aglio#including-files)
 - Swagger 2.0
-- Node.js 10.x, 12.x or higher
+- OpenAPI 3.0.3
+- Node.js 12.x, 14.x, 16.x or higher
 
 ## Install
 
@@ -30,6 +31,9 @@ $ apib2swagger -i api.md -o swagger.json
 $ apib2swagger -i api.md --yaml -o swagger.yaml
 $ apib2swagger -i api.md --prefer-reference
 $ apib2swagger -i api.md --bearer-apikey
+$ apib2swagger -i api.md --open-api-3
+$ apib2swagger -i api.md --info-title "My API Document Title"
+$ apib2swagger -i api.md --prefer-file-ref
 ```
 
 Without -i option it reads from STDIN, without -o option writes to STDOUT.
@@ -43,13 +47,33 @@ SwaggerUI will be automatically downloaded to current dir.
 ```shell
 $ apib2swagger -i api.md -s
 $ apib2swagger -i api.md -s -p 3000
+
+# When using file references and running the SwaggerUI server, you can specify the source
+# directory with the -sd flag. It will check the input directory and execution directory
+# if -sd is not given.
+$ apib2swagger -i api.md -s --prefer-file-ref -sd ~/project/src/
 ```
 
 Use as a library.
 ```javascript
 var apib2swagger = require('apib2swagger'),
     apib = '...',
-    options = { preferReference: true, bearerAsApikey: false };
+    options = { 
+        preferReference: true, 
+
+        // optional (Swagger 2.0 only).
+        bearerAsApikey: false,
+
+        // optional. swagger 2.0 is used by default.
+        openApi3: true, 
+
+        // optional. title will be grabbed from blueprint if not specified.
+        infoTitle: 'My API Document Title', 
+
+        // optional (Open API 3 only). 
+        // will set a $ref to the given file path instead of including the file contents.
+        preferFileRef: true 
+    };
 
 apib2swagger.convert(apib, options, function (error, result) {
     if (!error) console.log(result.swagger);
@@ -70,9 +94,11 @@ You can also run apib2swagger inside a docker container.
 $ docker run -it --rm -v $(pwd):/docs 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) 2015 Keisuke Minami
+Copyright (c) 2021 Keisuke Minami
 
 MIT
 

package/bin/apib2swagger.js

@@ -8,7 +8,8 @@ var fs = require('fs'),
     nopt = require('nopt'),
     yaml = require('js-yaml'),
     apibIncludeDirective = require('apib-include-directive'),
-    apib2swagger = require('../index.js');
+    apib2swagger = require('../index.js'),
+    util = require('../src/util');
 
 var options = nopt({
     'input': String,
@@ -19,14 +20,19 @@ var options = nopt({
     'yaml': Boolean,
     'prefer-reference': Boolean,
     'bearer-apikey': Boolean,
-    'help': Boolean
+    'help': Boolean,
+    'open-api-3': Boolean,
+    'info-title': String,
+    'prefer-file-ref': Boolean,
+    'source-dir': String
 }, {
     'i': ['--input'],
     'o': ['--output'],
     's': ['--server'],
     'p': ['--port'],
     'y': ['--yaml'],
-    'h': ['--help']
+    'h': ['--help'],
+    'sd': ['--source-dir']
 });
 
 if (options.help) {
@@ -47,8 +53,12 @@ if (options.help) {
     console.log("  -s --server Run http server with SwaggerUI.");
     console.log("  -p --port <port> Use port for the http server.");
     console.log("  -y --yaml Output YAML");
+    console.log("  -sd --source-dir Specify a source directory to serve file references from.");
     console.log("  --prefer-reference Refer to definitions as possible");
     console.log("  --bearer-apikey Convert Bearer headers to apiKey security schema instead of oauth2")
+    console.log("  --open-api-3 Output as OpenAPI 3.0 instead of the default Swagger 2.0")
+    console.log("  --info-title Optional info.title")
+    console.log("  --prefer-file-ref Create refs to file paths instead of importing the content.")
     process.exit();
 }
 
@@ -63,7 +73,11 @@ on('data', (chunk) => {
     apibData += chunk;
 }).on('end', () => {
     try {
-      apibData = apibIncludeDirective.includeDirective(includePath, apibData);
+        apibData = util.normalizeIncludes(apibData)
+        
+        if (!options['prefer-file-ref']){
+            apibData = apibIncludeDirective.includeDirective(includePath, apibData);
+        }
     } catch(e) {
       console.log(e.toString());
       return;
@@ -88,7 +102,13 @@ function processBlueprint(blueprint, opts) {
         return;
     }
 
-    var options = { preferReference: opts['prefer-reference'], bearerAsApikey: opts['bearer-apikey'] };
+    var options = {
+        preferReference: opts['prefer-reference'],
+        bearerAsApikey: opts['bearer-apikey'],
+        openApi3: opts['open-api-3'],
+        infoTitle: opts['info-title'],
+        preferFileRef: opts['prefer-file-ref']
+    };
     apib2swagger.convert(blueprint, options, function(error, result) {
         if (error) {
             console.log(error);
@@ -123,28 +143,34 @@ function processBlueprint(blueprint, opts) {
     });
 }
 
+function serveFile(response, path){
+    response.statusCode = 200;
+    response.write(fs.readFileSync(path));
+    response.end();
+    return;
+}
+
 function runServer(swagger) {
     var server = http.createServer(function(request, response) {
-        console.log(request.url);
-        var path = request.url.split('?')[0];
-        if (path === '/swagger.json') {
+        var filePath = request.url.split('?')[0];
+        if (filePath === '/swagger.json') {
             response.statusCode = 200;
             response.write(JSON.stringify(swagger));
             response.end();
-        } else if (path === '/') {
+        } else if (filePath === '/') {
             response.statusCode = 302;
             response.setHeader('Location', '/index.html?url=/swagger.json');
             response.end();
         } else {
-            var file = 'swagger-ui-master/dist' + path;
-            if (!fs.existsSync(file)) {
-                response.statusCode = 404;
-                response.end();
-                return;
-            }
-            response.statusCode = 200;
-            response.write(fs.readFileSync(file));
+            const swaggerFile = 'swagger-ui-master/dist' + filePath;
+            if (fs.existsSync(swaggerFile)) return serveFile(response, swaggerFile)
+
+            const file = util.getAbsolutePath(options, filePath)
+            if (file) return serveFile(response, file)
+
+            response.statusCode = 404;
             response.end();
+            return;
         }
     });
     console.log('Serving http://0.0.0.0:' + port + '/ ...');