新增springdoc

wangh_branch
王壕 2 years ago
parent 2c15d4f95b
commit a3e85432cc

@ -82,18 +82,27 @@
<artifactId>mybatis-plus-boot-starter</artifactId> <artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.1.1</version> <version>3.1.1</version>
</dependency> </dependency>
<!--swagger--> <!--springdoc 官方Starter-->
<dependency> <dependency>
<groupId>io.springfox</groupId> <groupId>org.springdoc</groupId>
<artifactId>springfox-swagger2</artifactId> <artifactId>springdoc-openapi-ui</artifactId>
<version>2.9.2</version> <version>1.6.6</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>com.github.xiaoymin</groupId> <groupId>org.springdoc</groupId>
<artifactId>swagger-bootstrap-ui</artifactId> <artifactId>springdoc-openapi-common</artifactId>
<version>1.9.2</version> <version>1.6.6</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-models</artifactId>
<version>2.1.12</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.12</version>
</dependency> </dependency>
</dependencies> </dependencies>

@ -6,7 +6,7 @@ import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.ComponentScan;
@SpringBootApplication @SpringBootApplication
@ComponentScan("com.example.demo.controller") @ComponentScan(basePackages = {"com.example.demo.controller" ,"com.example.demo.config"})
@MapperScan("com.example.demo.mapper") @MapperScan("com.example.demo.mapper")
public class DemoApplication { public class DemoApplication {

@ -0,0 +1,27 @@
package com.example.demo.config;
import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* SpringDoc API
* Created by macro on 2022/3/4.
*/
@Configuration
public class SpringDocConfig {
@Bean
public GroupedOpenApi publicApi() {
return GroupedOpenApi.builder()
.group("")
.pathsToMatch("")
.build();
}
}

@ -1,51 +0,0 @@
package com.example.demo.config;
import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* @author lyr
*/
@Profile({"prd","test","dev"})
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerConfig {
@Bean
public Docket api() {
// List<RequestParameter> globalRequestParameters = new ArrayList<>();
// RequestParameter build = new RequestParameterBuilder().name("abc").description("添加swagger公共请求参数abc").required(true).build();
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.qkc.stat.controller"))
.paths(PathSelectors.any())
.build()
// .globalRequestParameters(globalRequestParameters)
// .securitySchemes(securitySchemes()) //添加token
// .securityContexts(securityContexts()) //swagger配置页面访问是否需要传token
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("统计信息服务")
.description("统计服务相关接口")
.termsOfServiceUrl("127.0.0.1")
.version("1.0.0")
.build();
}
}

@ -1,31 +0,0 @@
package com.example.demo.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
/**
* @Author: lyr
* @Date: 2021-04-21 10:13
*/
@Configuration
public class WebMvnConfig extends WebMvcConfigurationSupport {
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
.allowedOrigins("*")
.allowedMethods("PUT", "DELETE", "GET", "POST", "OPTIONS")
.allowCredentials(true).maxAge(3600);
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}

@ -1,5 +1,9 @@
package com.example.demo.controller; package com.example.demo.controller;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.tags.Tags;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;
@ -14,9 +18,11 @@ import java.util.Map;
@RestController @RestController
@SpringBootApplication @SpringBootApplication
@Tag(name ="你的接口",description = "test")
public class ControllerText { public class ControllerText {
@Operation(summary = "获取用户列表",description = "test")
@RequestMapping("getUser") @RequestMapping("getUser")
public Map<String, Object> getUser(){ public Map<String, Object> getUser(){
System.out.println("微信小程序正在调用。。。"); System.out.println("微信小程序正在调用。。。");
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
@ -29,7 +35,7 @@ public class ControllerText {
System.out.println("微信小程序调用完成。。。"); System.out.println("微信小程序调用完成。。。");
return map; return map;
} }
@Operation(summary = "获取用户表",description = "test")
@RequestMapping("getWord") @RequestMapping("getWord")
public Map<String, Object> getText(String word){ public Map<String, Object> getText(String word){
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
@ -44,7 +50,7 @@ public class ControllerText {
map.put("message", message); map.put("message", message);
return map; return map;
} }
@Operation(summary = "获取列表",description = "test")
@RequestMapping("") @RequestMapping("")
public String getText(){ public String getText(){
return "hello world"; return "hello world";
@ -52,6 +58,7 @@ public class ControllerText {
@Autowired @Autowired
JdbcTemplate jct; JdbcTemplate jct;
@Operation(summary = "取用户列表",description = "test")
@GetMapping("userslist") @GetMapping("userslist")
public List<Map<String, Object>> userlist(){ public List<Map<String, Object>> userlist(){
String sql = "select * from user"; String sql = "select * from user";

Loading…
Cancel
Save