ssm整合japidocs文档

ssm整合japidocs文档

---

前言

对于学java的童鞋，只学java，不写接口文档的，就好像嘿咻不带套，流氓。。。对于我们这些软件工程来说，我们做的是像工程那么高大上，要有润滑剂，要有情趣等

pom 配置

<!-- api docs -->
<dependency>
  <groupId>io.github.yedaxia</groupId>
  <artifactId>japidocs</artifactId>
  <version>1.1</version>
</dependency>

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.0</version>
</dependency>

<dependency>
    <groupId>com.github.javaparser</groupId>
    <artifactId>javaparser-core</artifactId>
    <version>3.3.0</version>
</dependency>  

config 配置

 config.setProjectPath("D://java_code//yhSSM");

这里是配置项目的路径。
也可以配置docs文件输出的路径。。。

japidocs注解示例

 /**
 * 文案管理
 * @author colorbin
 * 创建时间: 2018年1月7日 上午1:24:35
 */
@Controller
@RequestMapping("/manage/document")
public class DocumentManageController extends BaseController { 

    /**
     * 批量删除
     * @param ids 文案IDs
     */
    @ApiDoc(YhResult.class)
    @RequestMapping("/deleteDocuments")
    @ResponseBody
    public Map<String,Object> deleteDocuments(@RequestParam String ids, HttpServletRequest request){

@ApiDoc-这里指定一个class 必须是本地目录存在的，如在jar包，则会报错，如是enum，则不输出
@RequestParam-指定字段 是否必须，如有则是必须。

注意：需要本文源代码可加QQ490647751 回复‘开通艳辉VIPssm整合japidocs文档’获取。关注我们的微信号，可以获取免费java福利。