codegen

README

Codegen 🚀

Generate Clean Architecture for REST API with support for Fiber Web Framework and gRPC in Golang. Speed up your development with automatic code generation.

✨ Features

• 🏗️ Clean Architecture - Automatically generates layered architecture structure
• 🔌 Fiber Framework Support - Optimized for the Fiber web framework
• 🌐 gRPC Support - Built-in support for gRPC services
• 🔄 CRUD Generation - Generate CRUD operations from JSON specifications
• 🛠️ Open API Generation - Generate Open API without configuration
• 🧩 Modular Design - Feature-based modules for better organization
• 🔧 Wire Integration - Dependency injection with Google Wire
• ⚡ Fast Development - Speed up your development workflow

📦 Installation

Latest version:

go install github.com/prongbang/codegen@v1.5.3

🚀 Quick Start

Generate OpenAPI spec from a Fiber codebase:

codegen openapi -framework fiber ./... > docs/openapi.json

1. Create a New Project

Generate a new project with module structure:

codegen -new test_project -mod github.com/prongbang

Parameters:

• -new: Project name
• -mod: Module name

This creates the following structure:

.
├── Makefile
├── cmd
│     └── api
│         └── main.go
├── configuration
│     ├── configuration.go
│     ├── development.yml
│     ├── environment.go
│     └── production.yml
├── deployments
│     ├── Dockerfile
│     └── api-prod.yml
├── docs
│     └── apispec
│         ├── docs.go
│         ├── swagger.json
│         └── swagger.yaml
├── go.mod
├── go.sum
├── internal
│     ├── app
│     │     ├── api
│     │     │     ├── api.go
│     │     │     ├── example
│     │     │     │     ├── datasource.go
│     │     │     │     ├── example.go
│     │     │     │     ├── handler.go
│     │     │     │     ├── permission.go
│     │     │     │     ├── provider.go
│     │     │     │     ├── repository.go
│     │     │     │     ├── router.go
│     │     │     │     └── usecase.go
│     │     │     └── routers.go
│     │     └── app.go
│     ├── database
│     │     ├── db.go
│     │     ├── drivers.go
│     │     ├── mariadb.go
│     │     ├── mongodb.go
│     │     ├── wire.go
│     │     └── wire_gen.go
│     ├── middleware
│     │     ├── api_key.go
│     │     ├── jwt.go
│     │     └── on_request.go
│     ├── pkg
│     │     ├── casbinx
│     │     │     └── casbinx.go
│     │     ├── response
│     │     │     └── response.go
│     │     └── validator
│     │         └── validator.go
│     └── shared
│           └── example
│               ├── datasource.go
│               ├── example.go
│               ├── provider.go
│               └── repository.go
│
├── pkg
│     ├── core
│     │     ├── common.go
│     │     ├── flag.go
│     │     ├── handler.go
│     │     ├── header.go
│     │     ├── jwt.go
│     │     ├── paging.go
│     │     ├── params.go
│     │     ├── request.go
│     │     ├── response.go
│     │     ├── router.go
│     │     └── sorting.go
│     ├── multipartx
│     │     └── multipartx.go
│     ├── requestx
│     │     └── request.go
│     ├── schema
│     │     └── sql.go
│     ├── streamx
│     │     └── streamx.go
│     ├── structx
│     │     └── structx.go
│     └── typex
│         └── typex.go
├── policy
│     ├── model.conf
│     └── policy.csv
├── spec
│     └── promotion.json
├── wire.go
└── wire_gen.go

1.1 Initial gRPC

codegen grpc init

This creates the initial gRPC scaffold under internal/app/grpc and generates the default health service.

1.2 Generate gRPC Server

codegen grpc server --new device

This creates:

internal/app/grpc/device/v1
├── device.proto
├── provider.go
└── server.go

It also updates:

• internal/app/grpc/servers.go
• wire.go

Then it runs:

make gen service=device version=v1
wire

1.3 Generate gRPC Client

Use the format <thirdparty>/<service>:

codegen grpc client --new core/device

This creates:

internal/thirdparty
├── Makefile
└── core
    ├── clients.go
    └── device
        └── v1
            ├── client.go
            └── device.proto

It also updates:

• internal/thirdparty/core/clients.go
• internal/thirdparty/Makefile

Then it runs:

make gen service=device version=v1 thirdparty=core

2. Generate Features Prototype

Generate a new feature module:

codegen -f user

This creates:

test-project/internal/app/api/promotion
├── datasource.go
├── handler.go
├── permission.go
├── promotion.go
├── provider.go
├── repository.go
├── router.go
└── usecase.go

3. Generate Features CRUD and Swagger

Generate CRUD operations from JSON specifications:

1. Define Spec File

Create spec/auth.json:

{
    "accessToken": "JWT",
    "expired": 1234567,
    "date": "2024-10-15T14:30:00Z"
}

2. Generate CRUD

• SQL Builder

codegen -f auth -s spec/auth.json -d mariadb -orm sqlbuilder

• Bun

codegen -f auth -s spec/auth.json -d mariadb -orm bun

This generates complete CRUD operations based on your JSON structure.

test-project/internal/app/api/promotion
├── datasource.go
├── handler.go
├── permission.go
├── promotion.go
├── provider.go
├── repository.go
├── router.go
└── usecase.go

4. Generate Shared Prototype

codegen -sh promotion

This generates shared prototype

test-project/internal/shared/promotion
├── datasource.go
├── promotion.go
├── provider.go
└── repository.go

5. Generate Shared CRUD

• SQL Builder

codegen -sh promotion -s spec/promotion.json -d maridb -orm sqlbuilder

• Bun

codegen -sh promotion -s spec/promotion.json -d maridb -orm bun

This generates shared CRUD operations based on your JSON structure.

test-project/internal/shared/promotion
├── datasource.go
├── promotion.go
├── provider.go
└── repository.go

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

💖 Support

If you find this tool helpful, please consider buying me a coffee:

🔗 Related Projects

• Fiber - Express-inspired web framework
• Wire - Compile-time dependency injection
• gRPC - High performance RPC framework

---