openapi-comment-parser | ️ JSDoc Comments for the OpenAPI Specification | REST library
kandi X-RAY | openapi-comment-parser Summary
kandi X-RAY | openapi-comment-parser Summary
A clean and simple way to document your code for generating OpenAPI (Swagger) specs.
Support
Quality
Security
License
Reuse
Top functions reviewed by kandi - BETA
Currently covering the most popular Java, JavaScript and Python libraries. See a Sample of openapi-comment-parser
openapi-comment-parser Key Features
openapi-comment-parser Examples and Code Snippets
Community Discussions
Trending Discussions on openapi-comment-parser
QUESTION
I have an OpenAPI spec from an API service I use (in the form of a swagger.json
file). I would like to expedite the dev process for generating my endpoints and it would be nice to have them documented with JSDoc to keep things running smoothly in VS Code.
I have found several JSDoc-to-Swagger/OpenAPI parsers and OpenAPI renderers, e.g.:
- https://www.npmjs.com/package/jsdoc-to-oas?activeTab=readme
- https://www.npmjs.com/package/openapi-comment-parser
- https://www.npmjs.com/package/express-jsdoc-swagger
However, these packages take JSDoc as the input, and render the Swagger / OpenAPI spec as the output. I'm looking to do the reverse. Google has not been helpful and I haven't seen much on StackOverflow either.
Does anyone have any recommendations short of implementing my own package for this?
...ANSWER
Answered 2021-Aug-10 at 16:05This package will generate code for you from your swagger, not exactly what you are after, but might be worth looking into.
Community Discussions, Code Snippets contain sources that include Stack Exchange Network
Vulnerabilities
No vulnerabilities reported
Install openapi-comment-parser
Support
Reuse Trending Solutions
Find, review, and download reusable Libraries, Code Snippets, Cloud APIs from over 650 million Knowledge Items
Find more librariesStay Updated
Subscribe to our newsletter for trending solutions and developer bootcamps
Share this Page