最好的API是使用Swagger工具构建的
Springfox参考文档

pom.xml中添加Swagger2坐标

<!-- swagger2配置 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>

新建Swagger2配置类

@EnableSwagger2
@Configuration
public class Swagger2Config {

//是否开启swagger
@Value(value = "${swagger.enabled}")
Boolean swaggerEnabled;

//过滤Swagger响应的API
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.micro.user.controller"))
.paths(PathSelectors.any())
.build();
}

//自定义信息
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
//标题
.title("Spring Boot 测试使用 Swagger2 构建RESTful API")
//创建人
//.contact(new Contact("xxx", "http://www.baidu.com", ""))
//版本号
.version("1.0")
//描述
.description("API 描述")
.build();
}

}

Controller层添加Swagger2文档注解

@RestController
@Api("用户接口")
public class UserController {

@Autowired
private UserInfoMapper userInfoMapper;

@ApiOperation("获取所有用户")
@GetMapping("/user")
@ResponseBody
public List<UserInfo> getUser(){
return userInfoMapper.selectAll();
}
}

启动项目，打开网址

http://localhost/swagger-ui.html