serverless-openapi-documenter 0.0.2 → 0.0.3

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: ''
+assignees: JaredCE
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+```
+serverless.yml
+  ...
+```
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Desktop (please complete the following information):**
+ - Serverless version: [e.g. 2.73.3]
+ - serverless-openapi-documenter version [e.g. 0.0.2]
+
+**Additional context**
+Add any other context about the problem here.

package/README.md

@@ -4,19 +4,39 @@ This will generate an OpenAPI V3 (up to v3.0.3) file for you from your serverles
 
 Originally based off of: https://github.com/temando/serverless-openapi-documentation
 
+## Install
+
+This plugin works for Serverless 2.x and up.
+
+To add this plugin to your package.json:
+
+**Using npm:**
+```bash
+npm install --save-dev serverless-openapi-documenter 
+```
+
+Next you need to add the plugin to the `plugins` section of your `serverless.yml` file.
+
+```yml
+plugins:
+  - serverless-openapi-documenter
+```
+
+> Note: Add this plugin _after_ `serverless-offline` to prevent issues with `String.replaceAll` being overridden incorrectly.
+
 ## Adding documentation to serverless
 
 To Run: `serverless openapi generate -o openapi.json -f json -a 3.0.3 -p postman.json`
 
 Options:
 
-| Option:      | What It Does: |
-|--------------|---------------|
-| -o filename | What filename the OpenAPI documentation should output under |
-| -f filetype | Whether to output the OpenAPI documentation as json or yaml |
-| -a OpenAPI Version | The version of OpenAPI v3 to conform too |
-| -p postman Collection filename | Whether to generate a postman collection from the OpenAPI v3 documentation and the filename to call it, json only |
-
+```
+--output                -o  What filename the OpenAPI documentation should output under. Default: openapi.json
+--format                -f  Whether to output the OpenAPI documentation as json or yaml. Default: json
+--indent                -i  File indentation in spaces. Default: 2
+--openApiVersion        -a  OpenAPI version to generate for. Default: 3.0.0
+--postmanCollection     -p  Will generate a postman collection (from the generated openAPI documentation), in json only, if passed in. Default postman.json
+```
 
 ### OpenAPI Mapping
 
@@ -312,26 +332,6 @@ requestHeaders:
 
 Please view the example [serverless.yml](test/serverless\ 2/serverless.yml).
 
-## Install
-
-This plugin works for Serverless 2.x and up.
-
-To add this plugin to your package.json:
-
-**Using npm:**
-```bash
-npm install serverless-openapi-documenter --save-dev
-```
-
-Next you need to add the plugin to the `plugins` section of your `serverless.yml` file.
-
-```yml
-plugins:
-  - serverless-openapi-documenter
-```
-
-> Note: Add this plugin _after_ `serverless-offline` to prevent issues with `String.replaceAll` being overridden incorrectly.
-
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documenter",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": ["serverless", "serverless2", "serverless3", "openAPI", "openAPIv3", "openAPI3", "PostmanCollections", "Postman-Collections"],

package/src/definitionGenerator.js

@@ -22,6 +22,8 @@ class DefinitionGenerator {
         this.openAPI = {
             openapi: this.version,
         }
+
+        this.operationIds = []
     }
 
     parse() {
@@ -50,14 +52,28 @@ class DefinitionGenerator {
                 if (event?.http?.documentation || event?.httpApi?.documentation) {
                     const documentation = event.http.documentation || event.httpApi.documentation
 
-                    const path = this.createOperationObject(event.http.method || event.httpApi.method, documentation, httpFunction.functionInfo.name)
+                    let opId
+                    if (this.operationIds.includes(httpFunction.functionInfo.name) === false) {
+                        opId = httpFunction.functionInfo.name
+                        this.operationIds.push(opId)
+                    } else {
+                        opId = `${httpFunction.functionInfo.name}-${uuid()}`
+                    }
+
+                    const path = this.createOperationObject(event.http.method || event.httpApi.method, documentation, opId)
                     if (httpFunction.functionInfo?.summary)
                         path.summary = httpFunction.functionInfo.summary
 
                     if (httpFunction.functionInfo?.description)
                         path.description = httpFunction.functionInfo.description
 
-                    Object.assign(paths, {[`/${event.http.path}`]: path})
+                    let slashPath = event.http.path
+                    const pathStart = new RegExp(/^\//, 'g')
+                    if (pathStart.test(slashPath) === false) {
+                        slashPath = `/${event.http.path}`
+                    }
+
+                    Object.assign(paths, {[slashPath]: path})
                 }
             }
         }