# ppw_gin_gen

**Repository Path**: ltotal/ppw_gin_gen

## Basic Information

- **Project Name**: ppw_gin_gen
- **Description**: ppw_gin代码生成工具
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-06-24
- **Last Updated**: 2024-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## ppw_gin_gen

#### 介绍
ppw_gin代码生成工具


#### 安装
```shell
go install gitee.com/ltotal/ppw_gin_gen@latest
```


#### 使用
```shell
ppw_gin_gen -defines api定义文件所在目录
```


#### api定义文件说明

```yaml
#支持单文件的单模块、多模块定义，也支持多文件的单模块、多模块混合定义

# 注1-Req.type 对应的 Gin binding 关联：
# json：binding.JSON
# xml：binding.XML
# form：binding.Form
# form_post：binding.FormPost
# multipart：binding.FormMultipart
# query：binding.Query
# protobuf：binding.ProtoBuf
# header：binding.Header

Api:
  Group: api # 路由分组
  Modules:
    - Name: Product # 模块名
      Tag: 产品 # api导出时的分类依据
      Endpoints:
        - Name: List # 模块功能处理器名
          Summary: 产品列表 # 处理器简介
          Desc: 获取产品列表信息 # 处理器说明
          Req: # 请求相关定义
            payload: payloads.ProductListReq # 请求存储结构体
            type: query # 详见"注1"
          Res: # 响应相关定义
            - code: 200 # 响应成功(200)
              payload: payloads.ProductListRes # 响应存储结构体
              type: json
          Route:
            path: /product/list # 路由
            method: get # 请求方式

        - Name: Detail
          Summary: 产品详情
          Desc: 获取产品详情信息
          Req:
            payload: payloads.ProductDetailReq
            type: query
          Res:
            - code: 200
              payload: payloads.ProductDetailRes
              type: json
          Route:
            path: /product/detail
            method: get

        - Name: Act
          Summary: 产品操作
          Desc: 产品信息操作
          Req:
            payload: payloads.ProductActReq
            type: form
          Res:
            - code: 200
              payload: payloads.ProductActRes
              type: json
          Route:
            path: /product/act
            method: post

        ......
```