<dependency>
    <groupId>io.github.shijiawei110</groupId>
    <artifactId>api4j</artifactId>
    <version>1.1.0</version>
</dependency>

    /**
     * 这是mvc get test注释，注释会被文档输出
     */
    @RequestMapping("/test")
    @ApiTag(name = "mvc测试接口", value = "这是mvc get test", author = "sjw")
    public Integer getTest1(@RequestParam(value = "test_name", required = false) String name) {
        return null;
    }
    

	//直接使用即可,将会扫描当前项目下的带有注解的类或者方法,输出文档打印到控制台
	ApiDocUtil.makeApiDoc();

	//需要输出md文档(默认生成路径在项目路径下的 /src/test/resources/apidoc)
	ApiDocUtil.makeApiDoc(ApiDocConf.defaultConf().mdSet());
	
	//如果需要指定输出目录
	ApiDocConf apiDocConf = new ApiDocConf().mdSet();
	apiDocConf.setDocOutputPath("/Users/download/apidoc");
	ApiDocUtil.makeApiDoc(apiDocConf);

	//如果需要指定请求地址的公用根路径:
	//比如 指定的请求url为 /getTest/getName 会变成/service/getTest/getName
	ApiDocUtil.makeApiDoc(ApiDocConf.defaultConf("service").mdSet());

public class ParamDemo {
    /**
     * 在这里写字段含义的注释可以在文档中输出
     */
    @NotNull
    private Long id;

    @JsonProperty("test_id")
    @Min(1)
    @Max(5)
    private Long testId;

    /**
     * age  jackson注解可以改变字段名
     */
    @JsonProperty("test_age")
    private Integer testAge;

    /**
     * 名称
     */
    @Length(min = 1, max = 100)
    private String testName;

    @NotBlank
    private String ok;

    @NotEmpty
    @Size(min = 1, max = 10)
    private List<String> reqStrs;

    /**
     * 书籍实体类
     */
    private Book book;
}

		//设置扫描的根路径
		String rootPath = "/Users/javaproject/project";
       ApiDocConf apiDocConf = ApiDocConf.customConf(rootPath);
       //添加类名加方法名 中间用.隔开
       apiDocConf.addMethod("ClassName1.MethodName1");
       apiDocConf.addMethod("ClassName1.MethodName2");
       //同理可以再控制台或者md文档输出
       ApiDocUtil.makeApiDoc(apiDocConf);