添加依赖
<!--swagger ui接口文档依赖--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> </dependency>
在common包配置,你不在这里也可以,随便你
import lombok.Data; import org.springframework.context.annotation.Bean; import org.springframework.stereotype.Component; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.oas.annotations.EnableOpenApi; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; @Component @EnableOpenApi @Data public class SwaggerConfiguration { @Bean public Docket webApiDoc() { return new Docket(DocumentationType.OAS_30) .groupName("用户端接口文档") .pathMapping("/") // 定义是否开启swagger,false为关闭,可以通过变量控制,线上关闭 .enable(true) //配置api文档元信息 .apiInfo(apiInfo()) // 选择哪些接口作为swagger的doc发布 .select() //扫描包的位置 .apis(RequestHandlerSelectors.basePackage("net.xdclass")) //正则匹配请求路径,并分配至当前分组 .paths(PathSelectors.ant("/api/**")) //开始构件 .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("1024电商平台") .description("微服务接口文档") .contact(new Contact("DBC", "QQ:957955071", "957955071@qq.com")) .version("12") .build(); } }
随便加一点你想要干什么的东西,可以简单的实现了
@Api(tags = "收货地址模块") @RestController @RequestMapping("/api/address/v1/") public class AddressController { @Autowired private AddressService addressService; @ApiOperation("根据ID查找地址详情") @GetMapping("/find/{address_id}") public Object detail( @ApiParam(value = "地址id",required = true) @PathVariable("address_id") long addressId){ return addressService.detail(addressId); } }
我相信这样你也看得懂

点这里,还可以直接测试








本文作者为DBC,转载请注明。