ICAT技术 阅读:1215评论: 1 2018-08-14

简介:

程序员每次都要写api接口文档,一个机械化的动作,没有技术含量,麻烦。现在有了JApiDocs,可以自动给你生成api文档页面,只需要你在写代码的时候写好注释。他就可以自动识别,给你生成api文档页面,听起来是不是很方便?下面,废话少说,教大家如何使用。


(1):创建一个简单的SpringBoot项目

image.png

导入的maven支持包

<dependency>
    <groupId>io.github.yedaxia</groupId>
    <artifactId>japidocs</artifactId>
    <version>1.2</version>
</dependency>


(2)创建一个简单的视图层Vo类和一个控制器,写一个简单的接口写好注释

SysUser视图Vo类

package com.example.vo;

import java.io.Serializable;

/**
 * 系统用户
 * 
 * @ClassName: SysUserVo
 * @Description: TODO
 * @author icat
 * @date 2018年8月14日 下午5:20:55
 *
 */
public class SysUserVo implements Serializable {
	private static final long serialVersionUID = 1L;
	private int id;// id
	private String username;// 用户账号
	private String password;// 密码

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getUsername() {
		return username;
	}

	public void setUsername(String username) {
		this.username = username;
	}

	public String getPassword() {
		return password;
	}

	public void setPassword(String password) {
		this.password = password;
	}

}




IndexController控层类

package com.example.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

import com.example.vo.SysUserVo;

import io.github.yedaxia.apidocs.ApiDoc;

/**
 * 用户测试接口
 * 
 * @ClassName: IndexController
 * @Description: TODO
 * @author icat
 * @date 2018年8月14日 下午3:34:10
 *
 */
@Controller
public class IndexController {

	/**
	 * 获取用户信息
	 * @param id 用户id
	 * @param token 用户秘钥
	 */
	@ApiDoc(SysUserVo.class)
	@RequestMapping(path = "/v1/get/user", method = { RequestMethod.GET })
	public void getUser(@RequestParam Integer id,@RequestParam String token) {

	}
}

@ApiDoc是视图返回的结果集


(3)生成页面的main方法

public static void main(String[] args) {
	Docs.DocsConfig docsConfig = new Docs.DocsConfig();
	docsConfig.setProjectPath("/Users/icat/eclipse-workspace/SpringBootDemo");
	docsConfig.setDocsPath("/Users/icat/eclipse-workspace/SpringBootDemo/doc");
	Docs.buildHtmlDocs(docsConfig);
}


setProjectPath是项目的地址

setDocsPath生成后的页面地址


运行main方法生成页面

image.png


项目中就有了这几个api文档页面

(4)找到文件,访问index.html


65FE18E202691D28D145C8F9D5A54522.jpg




转载请注明来源:

评论