1.创建springboot程序(基本知识)
2在pom.xml引入pom
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
</dependency>
3.配置Swagger配置文件,注意这个文件要被Spingboot扫描到
package server.config;
import io.swagger.annotations.ApiOperation;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
public class Swagger3Config {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("智能海上风电系统 接口文档")
.description("汇通远德智能海上风电系统")
// .contact(new Contact("htyd。", "http://www.huyd.com", "htyd@163.com"))
.version("1.0.0")
.build();
}
}
4.启动类注意扫描该swagger配置类,启动访问该地址:http://localhost:8080/swagger/swagger-ui/index.html
package server;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.oas.annotations.EnableOpenApi;
@RestController
@SpringBootApplication(scanBasePackages = "server")
@EnableOpenApi
public class Myapplication {
@RequestMapping("/")
String home() {
return "Hello World!";
}
public static void main(String[] args) {
SpringApplication.run(Myapplication.class, args);
}
}