spring整合knif4j启动

1.1配置类

先导一个配置类,配置类的配置如下

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("测试==demo")
                        .description("# swagger-bootstrap-ui-demo RESTful APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .contact(new Contact("玉面小白龙", "", "123@qq.com"))
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定文档Controller层扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.**.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;

    }
}

1.2依赖导入

配置文件好了后,我们导入3个依赖

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>

3个依赖,导入完后再去配置文件里配置一下mvc版本的问题,防止底下启动报错

3.spring-mvc

核心是mvc那一块,我是手敲了一个,配置文件不能出问题,出了问题启动报错

我是新创了一个项目弄得,事实证明可以用,启动后ip:端口/doc.html

就有了

如果加了拦截器,拦截器需要放行

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring Boot整合Knife4j可以快速生成API接口文档,可以让前后端更好的协作,提高开发效率。下面是整合步骤: 1. 引入依赖 在pom.xml文件中添加Knife4j的依赖: ``` <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>2.0.2</version> </dependency> ``` 2. 配置SwaggerSpring Boot启动类上添加@EnableSwagger2注解开启Swagger,示例代码如下: ``` @SpringBootApplication @EnableSwagger2 public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } } ``` 3. 配置Knife4j 在application.properties文件中配置Knife4j的相关属性,示例代码如下: ``` # 设置Knife4j文档页面的标题 spring.application.name=Demo # 配置Knife4j的访问路径 springfox.documentation.swagger.v2.path=/api-docs # 配置Knife4j的UI页面访问路径 knife4j.swagger-ui.path=/doc.html ``` 4. 编写API文档 在Controller类上使用Swagger注解编写API文档,示例代码如下: ``` @RestController @RequestMapping("/user") @Api(tags = "用户管理") public class UserController { @ApiOperation(value = "获取用户列表", notes = "获取所有用户列表") @GetMapping("/") public List<User> list() { // ... } @ApiOperation(value = "创建用户", notes = "根据User对象创建用户") @PostMapping("/") public String create(@RequestBody User user) { // ... } @ApiOperation(value = "更新用户", notes = "根据User对象更新用户") @PutMapping("/") public String update(@RequestBody User user) { // ... } @ApiOperation(value = "删除用户", notes = "根据用户ID删除用户") @DeleteMapping("/{id}") public String delete(@PathVariable Long id) { // ... } } ``` 5. 查看API文档 启动Spring Boot应用程序后,访问http://localhost:8080/doc.html即可查看API文档页面。 以上就是Spring Boot整合Knife4j的步骤,希望对你有所帮助。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值