# jkdoc

**Repository Path**: eric-ning/jkdoc

## Basic Information

- **Project Name**: jkdoc
- **Description**: idea接口文档生成插件
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-08-30
- **Last Updated**: 2023-03-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# jkdoc

#### 介绍
idea接口文档生成插件

#### 软件架构
jkdoc是由japidocs修改而来，旨在替代swagger，实现无代码侵入，仅仅使用javadoc注释就能生成接口文档


#### 安装教程

1.  在idea插件商店里搜索JKDoc，然后安装
2.  在项目根目录下新建一个jkdoc.json

```
{
    "baseUrl":"127.0.0.1:8282",//基础请求路径--必须
    "projectName":"jkdoc测试",//项目名，文档名--必须
    "version":"v1",//文档版本--必须
    "outputPath":"G:\\myplugin\\myapidoc\\src\\main\\resources\\static",//默认放在项目static目录下，有服务器环境，在线调试才能生效
    "ifDebug": true,//是否开启在线调试，默认不开启
    "tokenKey": "Authentication"//配置此参数则默认开启token，否则不开启
}
```

3.  Tools下点击JKDoc生成文档，或者ctrl+I生成文档

#### 使用说明

1.  xxxx
2.  xxxx
3.  xxxx

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)