fix globbing bug and update interface

Author: bourdakos1

README.md

@@ -20,31 +20,30 @@ $ yarn add openapi-comment-parser
 
 ## Usage
 
-```js
-const commentParser = require('openapi-comment-parser');
+Create a yaml file with a base OpenAPI definition:
+```yaml
+openapi: 3.0.0
+info: 
+  title: Title of your service
+  version: 1.0.0
+```
 
-// normal OpenAPI definition
-const baseDefinition = {
-  openapi: '3.0.0',
-  info: {
-    title: 'Title of your service',
-    version: '1.0.0',
-  },
-};
+Add the following to your code:
+```js
+const openapi = require('openapi-comment-parser');
 
-const spec = commentParser(baseDefinition);
+const spec = openapi();
 ```
 
 ### Swagger UI Express example
 Swagger UI Express is a popular module that allows you to serve OpenAPI docs from express.
 The result is living documentation for your API hosted from your API server via a route.
 
 ```js
-const path = require('path');
-const commentParser = require('openapi-comment-parser');
+const openapi = require('openapi-comment-parser');
 const swaggerUi = require('swagger-ui-express');
 
-const spec = commentParser(baseDefinition);
+const spec = openapi();
 
 app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(spec));
 ```
@@ -53,7 +52,7 @@ app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(spec));
 There are a few configuring options. For example, including and excluding certain
 files and paths:
 ```js
-const spec = commentParser(baseDefinition, {
+const spec = openapi({
   exclude: ['**/some/path/**']
 });
 ```

example/src/app.js

@@ -1,12 +1,11 @@
 const swaggerUi = require('swagger-ui-express');
 const express = require('express');
 
-const parseComments = require('../../dist/openapi-comment-parser');
+const openapi = require('../../dist/openapi-comment-parser');
 
 const petRouter = require('./routes/pet');
 const storeRouter = require('./routes/store');
 const userRouter = require('./routes/user');
-const definition = require('./openapi-definition');
 
 const app = express();
 const PORT = 3000;
@@ -15,7 +14,7 @@ const PORT = 3000;
 app.use(express.json());
 app.use(express.urlencoded({ extended: false }));
 
-const spec = parseComments(definition);
+const spec = openapi();
 
 app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(spec));
 

example/src/openapi-definition.js

@@ -0,0 +1,32 @@
+openapi: 3.0.3
+info:
+  title: Swagger Petstore
+  version: 1.0.5
+  description: >
+    This is a sample server Petstore server.  You can find out more about Swagger
+    at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).
+    For this sample, you can use the api key `special-key` to test the authorization filters.
+  termsOfService: http://swagger.io/terms/
+  contact:
+    email: [email protected]
+  license: 
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0.html
+
+tags: 
+- name: pet
+  description: Everything about your Pets
+  externalDocs: 
+    description: Find out more
+    url: http://swagger.io
+- name: store
+  description: Access to Petstore orders
+- name: user
+  description: Operations about user
+  externalDocs: 
+    description: Find out more about our store
+    url: http://swagger.io
+
+externalDocs:
+  description: Find out more about Swagger
+  url: http://swagger.io

example/src/petstore.yaml

@@ -34,7 +34,18 @@ class SpecBuilder implements OpenApiObject {
 
 	addData(parsedFile: OpenApiObject[]) {
 		parsedFile.forEach((file) => {
-			objectMerge(this, file);
+			const { paths, components, ...rest } = file;
+
+			// only merge paths and components
+			objectMerge(this, {
+				paths: paths,
+				components: components,
+			} as OpenApiObject);
+
+			// overwrite everthing else:
+			Object.entries(rest).forEach(([key, value]) => {
+				this[key as keyof OpenApiObject] = value;
+			});
 		});
 	}
 }