栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Yapi接口一键生成Java代码

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Yapi接口一键生成Java代码

文章目录
        • 一、简介
          • 1. 这是什么
          • 2. 有啥用
          • 3. 为什么要用
        • 二、快速开始
          • 1.下载
          • 2.配置
          • 3.运行
        • 三、版本说明
          • v1.0.0
        • 四、Github项目地址

一、简介 1. 这是什么

这是一个Java代码生成器。

2. 有啥用

能把Yapi上定义的接口生成可执行的Java代码,包括controler、service、entity等类文件,一键生成,方便快捷。

Yapi上的接口定义


生成的Java代码,有完整的类结构、方法、参数、变量等等,可直接使用

3. 为什么要用

Yapi上定义好接口之后,转换成Java代码时费时费力,都是重复劳动,毫无意义,所以有了这个工具把程序员从大量重复劳动中解放出来。

二、快速开始 1.下载

1)下载发布版本

最新版本:v1.0.0

将yaorongke-yapi-generator-1.0.0.zip解压到一个文件夹里,包含一个jar和一个配置文件

2)源码编译打包

# clone本项目源码
git clone https://github.com/yaorongke/yapi-generator.git
# 编译打包,jar包输出到target目录下
mvn clean package -Dmaven.test.skip=true
2.配置

修改application.properties,所有配置如下所示,前4项为yapi服务相关配置,请按实际情况填写;后4项为要生成的类文件的个性化配置,选填。yapi.api.interface.ids和yapi.api.cat.id只配置一个即可,两个都配置时会把包含的接口id合并。

# yapi服务地址
yapi.url=http://1.116.42.251:3000
# 每个项目都有唯一的标识token,用户可以使用这个token值来请求项目 openapi.
yapi.project.token=bb70d7d0d1511baa7873fb515398a7b935add6e3575s5d79e8c62805afb3b91f
# 需要生成Java代码的接口id,多个接口id时逗号隔开
yapi.api.interface.ids=11
# 需要生成Java代码的分类id,只支持单个分类id,配置该项会获取分类下的所有接口id
yapi.api.cat.id=

# 类文件的包路径
yapi.generator.base.package=com.rkyao.yapi.generator
# SINGLE: 所有接口生成到一个文件中 MULTIPLE: 每个接口一个文件
yapi.generator.class.patterns=SINGLE
# 显示在类文件注释中
yapi.generator.class.author=yaorongke
# patterns=single时 controller、service的默认名称
yapi.generator.class.defaultName=My

接口id和分类id在Yapi的页面url里可以找到


3.运行
java -jar yaorongke-yapi-generator.jar

生成的类文件会保存到与jar同级的output目录下。

三、版本说明 v1.0.0

目前1.0.0版本中,参数格式支持最常使用的Query和Body里的json格式,form、file、raw格式使用较少暂不支持,未来有时间会考虑兼容。

四、Github项目地址

https://github.com/yaorongke/yapi-generator

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/952598.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号