Knife在线API文档

1
<!-- Knife Spring Boot 在线API文档-->
2
        <dependency>
3
            <groupId>com.github.xiaoymin</groupId>
4
            <artifactId>knife4j-spring-boot-starter</artifactId>
5
            <version>2.0.9</version>
6
        </dependency>

1
@Slf4j
2
//@Lazy
3
@Api(tags = "3.图片管理模块")
4
@RestController
5
@RequestMapping("/album")
6
public class AlbumController {
7
    public AlbumController() {
8
        log.info("创建相册控制器对象.AlbumController");
9
    }
10
    @Autowired
11
    private IAlbumService albumService;
12

13
    public AlbumController(IAlbumService albumService) {
14
        log.info("创建相册控制器对象.AlbumController");
15
    }
16
    @ApiOperation("添加相册")
17
    @ApiOperationSupport(order = 10)
18
    @PostMapping("/add-new")
19
    public String addNew(AlbumAddNewDTO albumAddNewDTO){
20
         albumService.addNew(albumAddNewDTO);
21
    }
22
}

1
@Configuration
2
@EnableSwagger2WebMvc
3
public class Knife4jConfiguration {
4
//测试 http://localhost:9080/doc.html#/home
5
    /**
6
     * 【重要】指定Controller包路径
7
     */
8
    private String basePackage = "cn.tedu.jsdvn2203.csmall.server.controller";//导入控制器包
9
    /**
10
     * 分组名称
11
     */
12
    private String groupName = "product";
13
    /**
14
     * 主机名
15
     */
16
    private String host = "http://java.tedu.cn";
17
    /**
18
     * 标题
19
     */
20
    private String title = "酷鲨商城在线API文档--商品管理";
21
    /**
22
     * 简介
23
     */
24
    private String description = "酷鲨商城在线API文档--商品管理";
25
    /**
26
     * 服务条款URL
27
     */
28
    private String termsOfServiceUrl = "http://www.apache.org/licenses/LICENSE-2.0";
29
    /**
30
     * 联系人
31
     */
32
    private String contactName = "Java教学研发部";
33
    /**
34
     * 联系网址
35
     */
36
    private String contactUrl = "http://java.tedu.cn";
37
    /**
38
     * 联系邮箱
39
     */
40
    private String contactEmail = "java@tedu.cn";
41
    /**
42
     * 版本号
43
     */
44
    private String version = "1.0.0";
45

46
    @Autowired
47
    private OpenApiExtensionResolver openApiExtensionResolver;
48

49
    @Bean
50
    public Docket docket() {
51
        String groupName = "1.0.0";
52
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
53
                .host(host)
54
                .apiInfo(apiInfo())
55
                .groupName(groupName)
56
                .select()
57
                .apis(RequestHandlerSelectors.basePackage(basePackage))
58
                .paths(PathSelectors.any())
59
                .build()
60
                .extensions(openApiExtensionResolver.buildExtensions(groupName));
61
        return docket;
62
    }
63

64
    private ApiInfo apiInfo() {
65
        return new ApiInfoBuilder()
66
                .title(title)
67
                .description(description)
68
                .termsOfServiceUrl(termsOfServiceUrl)
69
                .contact(new Contact(contactName, contactUrl, contactEmail))
70
                .version(version)
71
                .build();
72
    }
73

74
}