#open-api #schema #generate #specification #jsdoc #js-doc #typedefs

app openapi-to-jsdoc

Generate JSDoc typedefs from OpenAPI 3.0.x spec schemas

3 releases

0.1.3 Apr 4, 2024
0.1.2 Mar 24, 2024
0.1.1 Mar 24, 2024

#403 in Database interfaces

MIT license

15KB
281 lines

Generates JSDoc @typedef for every schema in OpenAPI spec.


Install:

cargo install openapi-to-jsdoc

Usage

openapi-to-jsdoc -i https://api.example.com/openapi.json -o output.js

  • -i, --input (default: openapi.json) - Takes in path to file or URL to openapi.json
  • -i --output (default: types.js) - Output file

Dependencies

~12–26MB
~363K SLoC