https://github.com/unic/openapi-proptypes-generator

Generate PropTypes from openAPI 3 schemas
https://github.com/unic/openapi-proptypes-generator

Last synced: about 2 months ago
JSON representation

Generate PropTypes from openAPI 3 schemas

• Host: GitHub
• URL: https://github.com/unic/openapi-proptypes-generator
• Owner: unic
• License: lgpl-3.0
• Created: 2019-05-29T07:47:25.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-04-10T13:05:21.000Z (over 2 years ago)
• Last Synced: 2024-04-14T05:50:43.166Z (9 months ago)
• Language: JavaScript
• Size: 226 KB
• Stars: 2
• Watchers: 13
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# openapi-proptypes-generator

Generate PropTypes from openAPI 3, Swagger 2 in JSON or YAML schemas

## Usage

From your terminal, provide a source file in openAPI 3 or Swagger 2 in JSON or YAML format and a destination file where you would like your generated prop-types to be saved:

```sh

index.js ./examples/openapi.json ./examples/proptypes-openapi.js

```

or

```sh

index.js ./examples/openapi.yaml ./examples/proptypes-openapi.js

```

or for Swagger 2:

```sh

index.js ./examples/swagger.json ./examples/proptypes-swagger.js

```

Adding optional 3rd parameter - schemaToParse

```sh

index.js ./examples/openapi.yaml ./proptypes.js datamodels

```

will generate PropTypes only from given schema (if exists in source file, else it will generate all found schemas).

Alternatively you can also set an npm script in your `package.json`:

```json

{

  "scripts": {

    "generate": "index.js ./examples/openapi.json ./examples/proptypes.js"

  }

}

```

Then you can call it from your shell:

```sh

npm run generate

```

## Further development

- Use the proper node version, in this repo via [NVM](https://github.com/nvm-sh/nvm): `nvm use` (Stick to LTS versions only)

- Install the project: `npm ci`

## Roadmap

- Pass options through CLI

- Add tests

- Going UMD?

- Move to a template(s) based system instead of a string generation?