https://github.com/flum1025/sql-enum-generator

sql-enum-generator is a tool that parses SQL INSERT statements from a file and automatically generates OpenAPI schema files. The generated OpenAPI schema can be used with existing tools to generate type definitions in various programming languages.
https://github.com/flum1025/sql-enum-generator

code-generator go openapi3 postgresql sql

Last synced: about 1 month ago
JSON representation

sql-enum-generator is a tool that parses SQL INSERT statements from a file and automatically generates OpenAPI schema files. The generated OpenAPI schema can be used with existing tools to generate type definitions in various programming languages.

• Host: GitHub
• URL: https://github.com/flum1025/sql-enum-generator
• Owner: flum1025
• License: mit
• Created: 2024-12-28T11:35:54.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-28T17:22:41.000Z (about 1 month ago)
• Last Synced: 2024-12-28T17:26:56.326Z (about 1 month ago)
• Topics: code-generator, go, openapi3, postgresql, sql
• Language: Go
• Homepage:
• Size: 20.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sql-enum-generator

sql-enum-generator is a tool that converts SQL INSERT statements for master data into OpenAPI schemas. This application enables developers to easily generate enum representations of database master data using OpenAPI specifications, streamlining the development process and ensuring consistency between the database and application code.

Currently only postgresql is supported.

## Features

- Parses SQL INSERT statements and generates corresponding OpenAPI schemas

- Generated OpenAPI schemas can be utilized with other tools for type generation

## Quick Start

1. **Create a configuration file** named `sqlenumgen.yml` with the following content:

```yaml

version: "1"

tables:

  - name: products

    key: name

    value: id

```

2. **Run the application** using the following command:

```sh

$ go run github.com/flum1025/sql-enum-generator generate --source-path ./example/master.sql --output-path ./example/openapi.generated.json --config ./example/sqlenumgen.yml

```

3. **Utilize language-specific generation tools** to create enums from the generated OpenAPI schema.

For actual generation examples, please refer to the `example` directory in the repository.

## Language-Specific Usage Examples

### Go

For Go, you can use [oapi-codegen](https://github.com/oapi-codegen/oapi-codegen) to generate code from the OpenAPI schema. Create a configuration file named `oapi-codegen.yml` with the following content:

```yaml

package: main

output: ./openapi.generated.go

generate:

  models: true

compatibility:

  always-prefix-enum-values: true

output-options:

  skip-prune: true

```

Then, run the following command to generate the Go code:

```sh

$ go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen -config ./example/oapi-codegen.yml ./example/openapi.generated.json

```

### TypeScript

For TypeScript, you can use [openapi-typescript](https://github.com/openapi-ts/openapi-typescript) to generate TypeScript definitions. Run the following command:

```sh

$ npx openapi-typescript ./example/openapi.generated.json -o ./example/openapi.generated.d.ts --enum

```

## Future Plans

- [ ] Add support for additional SQL dialects

## License

This project is licensed under the MIT License. See the `LICENSE` file for details.