GO项目生成工具-根据库表字段自动生成API

本文介绍了一种利用Go语言开发的go-api-cli工具,能够根据数据库表结构自动生成API,简化CRUD操作,包括创建、读取、更新和删除功能,以及详细的API规则和使用步骤。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

根据库表字段自动生成API

一个项目开发离不开数据库的增删改查,API功能也基本围绕着表的CRUD:增加(Create)、读取(Read)、更新(Update)和删除(Delete)。每个表写一个CRUD,方法都差不多,逻辑也非常相似。
那么有没有可能根据表结构直接自动化生成各个表的CRUD呢?
当然可以,前几篇文章已经介绍了golang的API项目搭建和数据库操作,那么本篇直接一个飞跃成长,项目自动化生成。
本篇主要介绍一下本人开发的生成API项目的工具,https://github.com/liyonge-cm/go-api-cli
可以一键创建API项目,在创建了库表结构的情况下,配置需要生成API的表名,一个命令行就可以生成对应表的CRUD。
生成代码尽量简洁,方便根据项目实际需求二次开发。

API规则

首先建立好规则,方便生成逻辑统一的CRUD:

1.数据库表结构规则

  1. id为int类型自增数值
  2. 都有创建、更新时间,字段名固定为created_at,updated_at,且为int64类型,存值为时间戳
  3. 都有状态字段,字段名固定为status,int类型,初始值为0,删除为-1

2.CRUD规则

  1. Create时,除了id、status,created_at,updated_at,其他字段都作为入参,入库时初始status为0,创建、更新时间为当前时间戳
  2. Read时,带分页功能,分页参数统一为:limit(每页条数)、offset(第几页,从1开始),响应所有表字段原始数据
  3. Update时,必传id参数,除status,created_at,updated_at外的其他字段都可更改,更新时间自动设置为当前时间戳
  4. Delete时,必传id参数,status设置为-1,更新时间自动设置为当前时间戳

3. api 风格

  1. API method统一为post,body以json入参。如
curl -X POST "http://localhost:8080/user/getList" -H  "accept: application/json" -d "{
   \"limit\": 10,\"offset\": 1}" 
  1. 入参json支持camel-驼峰,snake-下划线,默认snake。

  2. 以表名作为group,crud分别为create,get,getList,update,delete。
    如有一个表名为user,生成API请求地址分别为:

  • http://localhost:8080/user/create
  • http://localhost:8080/user/get
  • http://localhost:8080/user/ge
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值