依赖
<!--swagger 依赖-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
配置
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
* @author zmj
*/
@Configuration
public class SwaggerConfiguration {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo()).select()
//为当前包路径
.apis(RequestHandlerSelectors.basePackage("com.zmj")).paths(PathSelectors.any()).build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
//页面标题
.title("郑煤机知识库Restful API接口文档")
//创建人
.contact(new Contact("郑煤机", "http://www.zmj.com/", ""))
//版本号
.version("1.0")
//描述
.description("API 描述").build();
}
}
代码
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.zmj.service.DocumentInfoService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@RestController
@RequestMapping("/documentInfo/")
@Api("解析数据")
public class DocumentInfoController {
@Autowired
private DocumentInfoService documentService;
@ApiOperation("生成html文件")
@PostMapping("generatehtml")
public String generatehtml() {
return null;
}
}
访问路径
http://localhost:8102/swagger-ui/
效果
这辈子坚持与不坚持都不可怕,怕的是独自走在坚持的道路上!!!