{"repo":"JaredCE/serverless-openapi-documenter","free":true,"listed":false,"github":"https://github.com/JaredCE/serverless-openapi-documenter","clone":"git clone https://github.com/JaredCE/serverless-openapi-documenter.git","description":"Serverless plugin to export your config as OpenAPI v3 Documentation and Postman Collection V2","language":"JavaScript","stars":46,"topics":["openapi","openapi-documentation","openapi-generator","openapi3","serverless","serverless-framework","openapi3-1","openapi31"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"OpenAPI Generator for serverless This will generate an OpenAPI V3 (up to v3.1.2) Document file for you from your serverless file. It can optionally generate a Postman Collection V2 or (as of 0.0.120) Bruno Collection from the OpenAPI file. This currently works for http and httpApi configurations. As of version 0.1.0, you can now create OpenAPI V3.1 (3.1.x) Documents, should you run the command serverless openapi generate -o openapi.json -f json -a 3.1.2 -p postman.json . Please see this guide on migrating to V3.1. Whilst I perosnally use this plugin all the time, please do open and report bugs, and I will do my best to fix them. Originally based off of: https://github.com/temando/serverless-openapi-documentation Install This plugin works for Serverless (2.x, 3.x and 4.x) and only supports node.js 20 and up. To add this plugin to your package.json: Using npm: Next you need to add the plugin to the plugins section of your serverless.yml file. 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.4 -p postman.json Options: README Highlighted Reading Security Details - Security - Security on All Operations - Security Per Operation Model Details - Models - Notes on Schemas - Request Schema Validators Response Headers - CORS - OWASP Secure Headers Validation - Validation OpenAPI Mapping OpenAPI field Serverless field -","default_branch":null,"files":null,"tree":[],"storefront":"/r/JaredCE","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/JaredCE/serverless-openapi-documenter/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}