niuhe - IDL 生成代码，前端协议, 页面和文档插件
官方教程地址 niuhe.zuxing.net
Vscode niuhe(牛河/河粉) 插件是一款面向golang的后端 IDL 代码生成(翻译)插件, 旨在实现前后端一致的 API设计, 开发和测试一体化协作开发流程, 提高开发效率. 它通过简单的 niuhe idl 语法 定义接口, 支持生成对应的 go 服务代码, 前端 api 定义, swagger 文档, 以及其他语言的协议.
niuhe IDl 是一种类似于 Python 的对象接口定义语言（Interface Definition Language, IDL），语法简洁，开发者易上手。
插件借助对 niuhe IDl 的支持与拓展，开发者只需定义一次接口就能多处复用，避免前后端重复定义，接口更新也无需繁琐通知。此外，插件还能自动生成 CURD 相关前后端代码，并搭配管理后台模板。
niuhe 插件通过一套接口定义生成多套一致代码，可减少重复劳动，提升开发效率，提升项目的一致性和可维护性，让团队聚焦核心业务，非常适合中小开发团队使用。
核心功能
| 功能模块 | 核心能力 | 适用场景 |
|---|---|---|
| Go语言支持 | 自动生成服务框架代码：包含路由管理niuhe、请求参数解析zpform、响应格式处理等基础代码niuhe。niuhe 和 zpform 两个库是本插件的基石 | 后端开发 |
| TypeScript支持 | 一键生成前端API调用代码，支持Web/小程序/React Native等场景 | 前端开发 |
| 文档生成 | 自动生成Swagger文档，支持导入Postman/Apifox等测试工具 【示例】, 接入 MCP 等 | 接口测试 |
| 多语言协议 | 生成标准化协议文件，支持自定义转换到其他编程语言 | 前端开发 |
Go服务核心特性
| 功能 | 优势 |
|---|---|
| 智能路由 | 自动根据文件结构生成路由配置，无需手动维护 |
| 参数处理 | 内置请求参数校验和响应格式化，专注业务逻辑开发 |
| XORM集成 | 自动生成数据库操作代码（表结构定义、DAO层、服务层） |
| CURD操作 | 自动生成CURD API逻辑代码 |
| 常量管理 | 统一管理业务常量，提升代码可维护性 |
配套解决方案
开提供开箱即用的管理系统模板，加速企业级应用开发：
| 解决方案 | 亮点 |
|---|---|
| Admin-Core | 内置RBAC权限体系，快速实现用户/角色/菜单管理 |
| Vue3管理模板 | 基于流行技术栈（Vue3+Element Plus），提供完整后台功能组件, 同时支持代码前端页面代码生成 |
实践案例
- admin-core-niuhe 完整示例项目（后端）
- admin-core-test 前端框架接入示例
- 在线演示 Vue3管理后台演示（账号: admin / 123456）
- niuhe插件生成文档导入 APIFOX 示例
登录都给拦截了 :joy:
关于 LearnKu
粤公网安备 44030502004330号
推荐文章：