第2部分今天的主题：智能文档接口文档生成工具
这是一个接口文档生成工具。我以前也推荐过swagger，但是这个工具在生产环境中不是很有用，而且对代码的干扰太大。现在，让我们介绍智能文档，一个接口文档工具。它可以识别Javadoc注释并在发布后生成文档，也就是说，只要您使用普通注释。
1依赖
首先我们需要引入依赖就好了
<dependency>
<groupId>com.github.shalousun</groupId>
<artifactId>smart-doc</artifactId>
<version>1.8.1</version>
<scope>test</scope>
</dependency>
2实现
我们可以写一个实体类来测试，只要这样写注释就好了
public class User {
/**
* 用户id
*/
private String userId;
/**
* 用户名
*/
private String userName;
/**
* 密码
*/
private String password;
/**
* 年龄
*/
private String age;
public User() {
}
public User(String userId, String userName, String password, String age) {
this.userId = userId;
this.userName = userName;
this.password = password;
this.age = age;
}
public String getUserId() {
return userId;
}
public void setUserId(String userId) {
this.userId = userId;
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public String getAge() {
return age;
}
public void setAge(String age) {
this.age = age;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
写两个控制类
/**
* 用户
*/
@RestController
public class UserAction {
/**
* 用户登录接口
* @author xujp
* @param userName 用户名
* @param password 密码
* @return
* @date 2021/7/31 15:31
*/
@RequestMapping("/login")
public User login(String userName,String password){
return new User("1",userName,password,"20");
}
}/**
* 测试
*/
@RestController
public class TestAction {
/**
* 测试用的接口
* @param str 字符串
* @return 12345
*/
@RequestMapping("/test")
public String test(String str){
return str;
}
}
这样我们就写好了两个控制类
现在我们去写一个文档生成工具
我们可以直接访问html,就可以了
欢迎关注：java后端指南