From 7aa76e5268b3256727544389da8f9d0bb27c444a Mon Sep 17 00:00:00 2001 From: 1517874642 <1517874642@qq.com> Date: Tue, 24 Nov 2020 09:35:10 +0800 Subject: [PATCH] swagger --- ... CustomerServiceProviderEnterpriseVO.java} | 0 .../entity/{Station.java => StationVO.java} | 0 .../hp/user/generactor/GeneratorCodeTest.java | 1 - .../user/service/UserServiceApplaction.java | 7 +-- .../hp/user/service/config/SwaggerConfig.java | 43 +++++++++++++++---- .../service/controller/AreaController.java | 8 +++- .../service/controller/CompanyController.java | 11 ++++- 7 files changed, 55 insertions(+), 15 deletions(-) rename user-client/src/main/java/com/hp/user/client/entity/{CustomerServiceProviderEnterprise.java => CustomerServiceProviderEnterpriseVO.java} (100%) rename user-client/src/main/java/com/hp/user/client/entity/{Station.java => StationVO.java} (100%) diff --git a/user-client/src/main/java/com/hp/user/client/entity/CustomerServiceProviderEnterprise.java b/user-client/src/main/java/com/hp/user/client/entity/CustomerServiceProviderEnterpriseVO.java similarity index 100% rename from user-client/src/main/java/com/hp/user/client/entity/CustomerServiceProviderEnterprise.java rename to user-client/src/main/java/com/hp/user/client/entity/CustomerServiceProviderEnterpriseVO.java diff --git a/user-client/src/main/java/com/hp/user/client/entity/Station.java b/user-client/src/main/java/com/hp/user/client/entity/StationVO.java similarity index 100% rename from user-client/src/main/java/com/hp/user/client/entity/Station.java rename to user-client/src/main/java/com/hp/user/client/entity/StationVO.java diff --git a/user-service/src/main/java/com/hp/user/generactor/GeneratorCodeTest.java b/user-service/src/main/java/com/hp/user/generactor/GeneratorCodeTest.java index b4ecf7a..e6d36ad 100644 --- a/user-service/src/main/java/com/hp/user/generactor/GeneratorCodeTest.java +++ b/user-service/src/main/java/com/hp/user/generactor/GeneratorCodeTest.java @@ -4,7 +4,6 @@ import java.util.Scanner; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; -import org.springframework.context.ConfigurableApplicationContext; import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySource; import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException; diff --git a/user-service/src/main/java/com/hp/user/service/UserServiceApplaction.java b/user-service/src/main/java/com/hp/user/service/UserServiceApplaction.java index 5dd81d7..8195550 100644 --- a/user-service/src/main/java/com/hp/user/service/UserServiceApplaction.java +++ b/user-service/src/main/java/com/hp/user/service/UserServiceApplaction.java @@ -1,10 +1,12 @@ package com.hp.user.service; +import cn.nyhlw.doc2swagger.springswagger2.EnableSwagger2; import org.mybatis.spring.annotation.MapperScan; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySource; +import org.springframework.context.annotation.ComponentScan; /** * 用户服务启动类 @@ -12,14 +14,13 @@ import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySource; * @since 2020/11/18 * */ +@EnableSwagger2 @MapperScan("com.hp.user.service.dao") //扫描的mapper @SpringBootApplication @NacosPropertySource(dataId = "userdatasource", autoRefreshed = true) +@ComponentScan("com.hp.user.service.config") public class UserServiceApplaction { - - public static void main(String[] args) { - SpringApplication.run(UserServiceApplaction.class, args); } } diff --git a/user-service/src/main/java/com/hp/user/service/config/SwaggerConfig.java b/user-service/src/main/java/com/hp/user/service/config/SwaggerConfig.java index 256670f..a6b2b85 100644 --- a/user-service/src/main/java/com/hp/user/service/config/SwaggerConfig.java +++ b/user-service/src/main/java/com/hp/user/service/config/SwaggerConfig.java @@ -2,23 +2,48 @@ package com.hp.user.service.config; import java.util.Arrays; +import cn.nyhlw.doc2swagger.springswagger2.EnableSwagger2; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import cn.nyhlw.doc2swagger.core.config.RestDocConfig; -import cn.nyhlw.doc2swagger.springswagger2.EnableSwagger2; +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 @EnableSwagger2 public class SwaggerConfig { + public static final String VERSION = "1.0.0"; + public static final String SWAGGER_SCAN_BASE_PACKAGE = "com.hp.user.service.controller"; @Bean - RestDocConfig _swaggerConfig() - { - return RestDocConfig.builder() - .apiTitle("rest doc user") - .apiDescription("用户信息系统") - .apiVersion("1.0.0") - .packages(Arrays.asList("com.hp.user.service.controller")) - .build(); + public Docket createRestApi() { + return new Docket(DocumentationType.SWAGGER_2) + .apiInfo(apiInfo()) + .select() + .apis(RequestHandlerSelectors.basePackage(SWAGGER_SCAN_BASE_PACKAGE)) + .paths(PathSelectors.any()) + .build(); + } + + private ApiInfo apiInfo() { + return new ApiInfoBuilder() + .title("rest doc user") + .description("用户信息系统") +// .termsOfServiceUrl("http://www.cnblogs.com/congc/") + .version(VERSION) + .build(); } +// RestDocConfig _swaggerConfig() +// { +// return RestDocConfig.builder() +// .apiTitle("rest doc user") +// .apiDescription("用户信息系统") +// .apiVersion("1.0.0") +// .packages(Arrays.asList("com.hp.user.service.controller")) +// .build(); +// } } diff --git a/user-service/src/main/java/com/hp/user/service/controller/AreaController.java b/user-service/src/main/java/com/hp/user/service/controller/AreaController.java index 44f9328..46fec14 100644 --- a/user-service/src/main/java/com/hp/user/service/controller/AreaController.java +++ b/user-service/src/main/java/com/hp/user/service/controller/AreaController.java @@ -4,12 +4,17 @@ import com.hp.user.client.entity.AreaVO; import com.hp.user.client.service.AreaService; import com.hp.user.service.dao.AreaMapper; import com.hp.user.service.entity.Area; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RestController; import java.util.List; +@Api(tags = "地区API接口") @RestController @RequestMapping("/area") public class AreaController { @@ -20,7 +25,8 @@ public class AreaController { /** * 查询所有地区 */ - @RequestMapping("/queryAllArea") + @GetMapping("/queryAllArea") + @ApiOperation(value = "获取所有地区信息", notes = "获取所有地区信息", httpMethod = "GET") public List queryAllArea(){ return areaService.getAllArea(); } diff --git a/user-service/src/main/java/com/hp/user/service/controller/CompanyController.java b/user-service/src/main/java/com/hp/user/service/controller/CompanyController.java index 9ac236b..0419515 100644 --- a/user-service/src/main/java/com/hp/user/service/controller/CompanyController.java +++ b/user-service/src/main/java/com/hp/user/service/controller/CompanyController.java @@ -1,16 +1,25 @@ package com.hp.user.service.controller; +import com.hp.user.client.service.CustomerCompanyService; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +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; +@Api(description = "公司API接口") @RestController @RequestMapping("/company") public class CompanyController { + @Autowired + private CustomerCompanyService customerCompanyService; /** * 添加企业 * 需要企业信息 */ - @RequestMapping("/addCompany") + @ApiOperation(value="新增企业") + @PostMapping("/addCompany") public void addCompany(){ }