go-sdk-generator

command module
v0.0.0-...-c1e7979 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 3, 2025 License: MIT Imports: 9 Imported by: 0

README

Go SDK Generator

基于 Swagger/OpenAPI 规范自动生成生产级 Go SDK 的工具。

功能特性
  • 🛠 全自动生成 - 从 Swagger 定义到完整可用的 Go SDK
  • 📦 模块化架构 - 生成:
    • 类型安全的客户端结构体
    • REST API 方法封装
    • 数据模型定义
    • 完善的错误处理
  • 🧩 智能代码生成
    • 自动处理路径/查询参数
    • 支持枚举类型生成
    • 自动导入依赖包
    • 代码格式标准化
  • 🔧 高度可配置
    • 忽略特定API路径
    • 排除模型字段
环境要求
  • Go 1.18+
  • Swagger 2.0/OpenAPI 规范文件
安装步骤
    go install cnb.cool/cnb/sdk/go-sdk-generator
使用指南
从本地文件生成
go-sdk-generator -i swagger.json -o ./sdk

从远程URL生成
go-sdk-generator -i https://api.example.com/swagger.json -o ./generated

使用自定义配置
go-sdk-generator -i swagger.json -o ./sdk -e config.yaml
配置说明

如果有些 api 的原始定义有些问题,你希望忽略它,那么可以配置如下

paths:
  /api/v1/users/{id}:
    GET:
      ignore: true

许可证

本项目采用 MIT 许可证

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳