栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

前后端API文档 knife4j

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

前后端API文档 knife4j

前后端API文档 knife4j相关配置

文档地址
ip:端口号/资源路径/doc.html

相关依赖

swagger 版本 3.0.3 2.0.8 ,springboot 版本选择2.7 以下不然会有空指针异常


		org.springframework.boot
		spring-boot-starter-parent
		2.3.5.RELEASE
		 
	
	com.example
	swagger
	0.0.1-SNAPSHOT
	swagger
	swagger
	
		1.8
		3.0.3
	
	

		
			org.springframework.boot
			spring-boot-devtools
			runtime
		
		
			org.springframework.boot
			spring-boot-starter-web
		

		
			org.springframework.boot
			spring-boot-starter-test
			test
		
		
		
			com.github.xiaoymin
			knife4j-spring-boot-starter
			
			${swagger.version}
		
		
			org.projectlombok
			lombok
		
	
Config 类
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 控制层包名,会自动扫描包里的所有接口
                .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        // 展示在主页的信息
        return new ApiInfoBuilder()
                // 文档标题
                .title("swagger测试")
                // 文档描述
                .description("swagger测试示例文档")
                // 你的联系方式
                .contact(new Contact("AllenIverrui", "test", "3037256239@qq.com"))
                // 文档版本
                .version("1.0")
                .build();
    }
}
实体类注解
@Data
@AllArgsConstructor
@NoArgsConstructor
public class HelloDTO {
    @ApiModelProperty("文本")
    String text;
}

控制器注解
@RestController
@Api(tags = "heloo 控制模块")
@RequestMapping("/HelloController")
public class HelloController {

    @ApiOperation("test1")
    @GetMapping("/test1")
    public HelloDTO  Test1(){
        return new HelloDTO("test123");
    }
}

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/1010542.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号