Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

48 changes: 48 additions & 0 deletions .github/workflows/gradle.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle

name: Java CI with Gradle

on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]

permissions:
contents: read

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up JDK 11
uses: actions/setup-java@v1
with:
java-version: '11'
- name: 缓存gradle
uses: actions/cache@v2
env:
cache-name: cache-gradle-yapiideaplugin
with:
path: |
~/.gradle/caches
~/.gradle/wrapper
key: ${{ runner.os }}-build-${{ env.cache-name }}
- name: Build with Gradle
run: ./gradlew buildPlugin
- name: 归档
env:
GITHUB_TOKEN: ${{ secrets.GIT_RELEASE_YAPI_IDEA_UPLOAD_PLUGIN }}
run: |
version=`cat build.gradle | grep -P "version '\\S+'" -o | sed "s/version '\(\S*\)'/\1/g"` \
&& echo "version=${version}" \
&& ls build/libs \
&& gh release create "v${version}" "build/libs/YapiIdeaUploadPlugin-${version}.jar"
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## [Unreleased]
### 中文
- 1.8.4: 修复崩溃问题,优化代码
- 1.8.3: 重构为gradle项目;增加同项目多模块配置
- 1.8.2: 将java 类型转为json
- 1.8.1: 支持idea 2020
- 1.7.9: fixbug
Expand All @@ -27,6 +29,8 @@
- 1.5:支持{@link} 的常量定义显示在备注
- 1.4:fixbug,备注中新增接口定义。
### ENGLISH
- 1.8.4 Fix the crash problem and optimize the code
- 1.8.3 Refactor to gradle project; add multi-module configuration of the same project
- 1.8.2: java type convert to json type
- 1.8.1: support idea 2020
- 1.7.9: fixbug
Expand Down
69 changes: 43 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,55 @@
#### 目的
减少yapi 录入时间,通过工具反向规范代码注释,和代码整洁
# YapiUploadPro
https://github.com/xujiaji/YapiIdeaUploadPlugin

#### 下载地址
1:<a href="https://github.com/diwand/YapiIdeaUploadPlugin/tree/master/disk" >github</a><br>
2:idea 插件库 <br>
更新速度 github>idea 插件库
En: Upload the interface of the spring boot project to the yapi server through the plug-in.

#### 支持语言
java,spring
Zh: 将SpringBoot项目的接口通过该插件上传到yapi服务器

#### 单个&批量
#### Purpose(目的)
En: Reduce yapi entry time, reverse standardize code comments through tools, and code cleanliness.

单个上传选中方法名称 <br>
批量上传选中类名 <br>
Zh: 减少yapi 录入时间,通过工具反向规范代码注释,和代码整洁

#### 支持接口
目前 dubbo 接口/api
#### How to use(使用方式)
En: 1. Find "YapiUpload" in idea settings and configure ypai.

#### 支持yapi 的版本
1.5.0+
Zh: 1、在idea设置中找到“YapiUpload”配置ypai

#### 支持idea 版本
2017+
![config](img.png)

En: 2. Add configuration (note: the module is an absolute path, and the path is used to determine which project to upload to yapi).

#### 使用方式
Zn: 2、添加配置(注意:模块是绝对路径,通过路径判断上传到yapi哪个项目)

查看 <a href="https://github.com/diwand/YapiIdeaUploadPlugin/wiki/%E5%BF%AB%E9%80%9F%E4%BD%BF%E7%94%A8">wiki</a>
![config](img_1.png)

En: 3. Right-click the controller interface file, and after the pop-up menu, click '点击UploadToYapi'.

#### 感谢
感谢以下同学提交的代码(排名不分先后)
- @24kpure
- @sun7132568
- @zouzou6321
- @zhanyao
- @Planeswalker23
Zn: 3、右键controller接口文件,弹窗菜单后,点击UploadToYapi

> En: Some comment configuration

|Show Effects|Tags|Location|
|--|--|--|
|Main Category|@menu:|Add on Category|
|Subcategory|@menu:|Add on method|
|Interface Status Mark|@status under development (or undone)<br/>&emsp;&emsp;&emsp;&emsp;released(done)<br/>&emsp;&emsp;&emsp;&emsp;design(design)<br/ >&emsp;&emsp;&emsp;&emsp;testing<br/>&emsp;&emsp;&emsp;&emsp;deprecated<br/>&emsp;&emsp;&emsp;&emsp;stopping< br/>&emsp;&emsp;&emsp;&emsp; (Note: do not write the default development)|Add on the method|
|Specify the interface path |@path| add on the method|

Other see: https://github.com/diwand/YapiIdeaUploadPlugin/wiki/%E5%BF%AB%E9%80%9F%E4%BD%BF%E7%94%A8

> Zn: 一些注释配置

|显示效果|标记|位置|
|--|--|--|
|主分类|@menu:|类上添加|
|子分类|@menu:|方法上添加|
|接口状态标记|@status 开发中 (或者 undone)<br/>&emsp;&emsp;&emsp;&emsp;已发布(done)<br/>&emsp;&emsp;&emsp;&emsp;设计中(design)<br/>&emsp;&emsp;&emsp;&emsp;已提测(testing)<br/>&emsp;&emsp;&emsp;&emsp;已过时(deprecated)<br/>&emsp;&emsp;&emsp;&emsp;暂停开发(stoping)<br/>&emsp;&emsp;&emsp;&emsp;(注:不写默认开发中)|方法上添加|
|指定接口路径|@path|方法上添加|

其它见:https://github.com/diwand/YapiIdeaUploadPlugin/wiki/%E5%BF%AB%E9%80%9F%E4%BD%BF%E7%94%A8

#### About (关于)
En: Refactored from:https://github.com/diwand/YapiIdeaUploadPlugin

Zn: 重构自:https://github.com/diwand/YapiIdeaUploadPlugin
39 changes: 21 additions & 18 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
import org.jetbrains.changelog.ExtensionsKt

plugins {
id 'java'
id "org.jetbrains.intellij" version "0.6.5"
id 'org.jetbrains.changelog' version '1.1.2'
id "org.jetbrains.intellij" version "1.13.2"
id 'org.jetbrains.changelog' version "1.1.2"
}
apply plugin: 'org.jetbrains.changelog'

group 'com.dbb'
version '1.8.2'
group 'com.xujiaji'
version '1.8.7'

repositories {
mavenCentral()
Expand All @@ -17,26 +19,27 @@ dependencies {
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
}

// See https://github.com/JetBrains/gradle-intellij-plugin/
// Configure Gradle IntelliJ Plugin
// Read more: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html
intellij {
version = '2022.2'
type = "IC"
plugins = ["java"]
version '2020.1'
}
patchPluginXml {
sinceBuild('1')
untilBuild('203.*')

pluginDescription = {
def lines = rootProject.file('README.md').readLines()
// README中插件描述开始的标签
// def start = lines.indexOf('<!--plugin-desc-->')
// README中插件描述结束的标签
// def end = lines.indexOf('<!--/plugin-desc-->')
// def description = lines.subList(start + 1, end).join('\n')
org.jetbrains.changelog.ExtensionsKt.markdownToHTML(lines.join('\n'))
}
sinceBuild = "221"
untilBuild = "231.*"

pluginDescription = ExtensionsKt.markdownToHTML(
rootProject.file('README.md').readLines().join('\n')
)
changeNotes = changelog.getUnreleased().toHTML()
}

publishPlugin {
token = System.getenv("ORG_GRADLE_PROJECT_intellijPublishToken")
}

test {
useJUnitPlatform()
}
Expand Down
Binary file removed disk/YapiUpload1.3.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.4.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.5.1.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.5.2.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.5.3.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.5.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.6.0.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.6.1.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.6.2.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.6.3.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.6.4.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.6.5.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.6.6.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.6.7.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.6.8.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.6.9.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.7.0.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.7.1.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.7.2.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.7.3.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.7.4.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.7.5.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.7.6.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.7.7.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.7.8.jar
Binary file not shown.
Binary file removed disk/YapiUpload1.7.9.jar
Binary file not shown.
Binary file modified gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
2 changes: 1 addition & 1 deletion gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.1-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
Loading