ToB企服应用市场:ToB评测及商务社交产业平台

标题: springboot整合 knife4j 接口文档 [打印本页]

---

作者: tsx81428    时间: 2024-7-31 06:10
标题: springboot整合 knife4j 接口文档
第一步：引入依赖

1. <dependency>
2.             <groupId>com.github.xiaoymin</groupId>
3.             <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
4.             <version>4.4.0</version>
5.         </dependency>

复制代码

第二步：写入配置
方法一：编写一个工具类

1. import org.springframework.context.annotation.Bean;
2. import org.springframework.context.annotation.Configuration;
3. import springfox.documentation.builders.ApiInfoBuilder;
4. import springfox.documentation.builders.PathSelectors;
5. import springfox.documentation.builders.RequestHandlerSelectors;
6. import springfox.documentation.service.ApiInfo;
7. import springfox.documentation.service.Contact;
8. import springfox.documentation.spi.DocumentationType;
9. import springfox.documentation.spring.web.plugins.Docket;
10. import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
13. @Configuration
14. @EnableSwagger2WebMvc
15. public class Knife4jConfiguration {
17.     private ApiInfo groupApiInfo(){
18.         return new ApiInfoBuilder()
19.                 .title("herbig接口文档")
20.                 .description("Smart Claims RESTful APIs")
21.                 .termsOfServiceUrl("http://localhost:8077/")
22.                 .contact(new Contact("herbig祺","","邮箱"))
23.                 .description("测试描述")
24.                 .version("4.0")
25.                 .build();
26.     }
28.     @Bean
29.     public Docket appApi() {
30.         return new Docket(DocumentationType.SWAGGER_2)
31.                 .apiInfo(groupApiInfo())
32.                 .groupName("移动端接口")
33.                 .select()
34.                 .apis(RequestHandlerSelectors.basePackage("com.herbig.app"))
35.                 .paths(PathSelectors.any())
36.                 .build();
37.     }
39.     @Bean
40.     public Docket pcApi() {
41.         return new Docket(DocumentationType.SWAGGER_2)
42.                 .apiInfo(groupApiInfo())
43.                 .groupName("网页端接口")
44.                 .select()
45.                 .apis(RequestHandlerSelectors.basePackage("com.herbig.pc"))
46.                 .paths(PathSelectors.any())
47.                 .build();
48.     }
50. }

复制代码

方法二：在yml里面配置

1. knife4j:
2.   enable: true
3.   openapi:
4.     title: herbig接口文档
5.     description: 测试描述
6.     email: 邮箱
7.     concat: herbig祺
8.     url: http://localhost:8077/
9.     version: v4.0
10.     license: Apache 2.0
11.     license-url: http://localhost:8077/
12.     terms-of-service-url: http://localhost:8077/
13.     group:
14.       test1:
15.         group-name: 移动端接口
16.         api-rule: package
17.         api-rule-resources:
18.           - com.knife4j.demo.new3
19.       test2:
20.         group-name: 网页端接口
21.         api-rule: package
22.         api-rule-resources:
23.           - com.knife4j.demo.new3

复制代码

第三步：启动项目——访问地址 http://ip:端口号/doc.html#/

番外：如果提供给别人接口API时不希望所有人都能看到可以加一些登录限制 在yml文件中

1. knife4j:
2.   enable: true
3.   basic:
4.     enable: true
5.     password: 123123
6.     username: 123123

复制代码

这样访问地址就会出现登录提示，出入用户名和密码即可检察

测试用例：

1. @RestController
2. @RequestMapping("/one")
3. @Api(value = "测试接口",tags = "测试接口")//接口文档的api组名
4. public class Knife4jController {
6.     @ApiOperation(value = "接口释义", notes = "接口释义")//接口释义
7.     @RequestMapping(value = "/two", method = RequestMethod.POST)
8.     @ApiImplicitParams({
9.             @ApiImplicitParam(name = "canshu", value = "参数", required = false)//参数 required是否必填
10.     })
11.     public String doGetStudyFileDataList() {
12.         return "啦啦啦，成功了";
13.     }
14. }

复制代码

结果 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

---

欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)

Powered by Discuz! X3.4