添加swagger online文档

ccf8781b · Simon Cheng · f52f5c49 · ccf8781b · ccf8781b · ccf8781b
Commit ccf8781b authored Apr 13, 2020 by Simon Cheng
6 changed files
--- a/yd-api/pom.xml
+++ b/yd-api/pom.xml
@@ -93,7 +93,17 @@
 			<groupId>com.github.pagehelper</groupId>
 			<artifactId>pagehelper-spring-boot-starter</artifactId>
 			<version>1.2.5</version>
-		</dependency>		
+		</dependency>	
+		<dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>2.8.0</version>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>2.8.0</version>
+        </dependency>
    </dependencies>
    <build>

--- a/yd-api/src/main/java/com/yd/api/commission/CommissionController.java
+++ b/yd-api/src/main/java/com/yd/api/commission/CommissionController.java
 package com.yd.api.commission;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 import com.yd.api.commission.service.CommissionService;
-@Controller
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiOperation;
+@Api(value="/commission", tags="佣金接口:")
 @RestController
 public class CommissionController {
@@ -19,6 +22,8 @@ public class CommissionController {
 	 * @param login
 	 * @return
 	 */
+	@ApiOperation(value="根据登录账号查询用户佣金", notes = "根据登录账号查询用户佣金", httpMethod = "POST")
+    @ApiImplicitParam(name="login", value="String", required = true)	
 	@RequestMapping("/queryCommissionByLogin")
 	public Object queryCommissionByLogin(@RequestBody String login){
@@ -30,6 +35,8 @@ public class CommissionController {
 	 * @param login
 	 * @return
 	 */
+	@ApiOperation(value="根据登录账号查询EGolden用户佣金", notes = "根据登录账号查询EGolden用户佣金", httpMethod = "POST")
+    @ApiImplicitParam(name="login", value="String", required = true)		
 	@RequestMapping("/queryCommissionByLoginFromEGolden")
 	public Object listAllUserfromEGolden(@RequestBody String login){

--- a/yd-api/src/main/java/com/yd/api/customer/CustomerController.java
+++ b/yd-api/src/main/java/com/yd/api/customer/CustomerController.java
 package com.yd.api.customer;
 import java.util.List;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -14,16 +13,20 @@ import com.yd.api.customer.vo.CustomerFortuneResponseVO;
 import com.yd.api.customer.vo.CustomerQueryRequestVO;
 import com.yd.api.customer.vo.CustomerQueryResponseVO;
 import com.yd.api.customer.vo.CustomerVO;
-import com.yd.api.market.vo.announcement.AnnouncementQueryResponseVO;
 import com.yd.api.result.JsonResult;
-@Controller
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiOperation;
+@Api(value="/customer", tags="用户接口:")
 @RestController
 public class CustomerController {
 	@Autowired
 	private CustomerService customerService;
+    @ApiOperation(value="查询所有用户信息", notes = "查询所有用户信息", httpMethod = "GET",response = Object.class)
 	@RequestMapping("/listAllCustomer")
 	public Object listAllCustomer(){
        JsonResult result = new JsonResult();
@@ -39,6 +42,8 @@ public class CustomerController {
 	 * @param customerQueryRequestVO
 	 * @return
 	 */
+    @ApiOperation(value="分页查询用户列表", notes = "分页查询用户列表", httpMethod = "POST",response = CustomerQueryResponseVO.class)
+    @ApiImplicitParam(name="customerQueryRequestVO", value="CustomerQueryRequestVO", required = true, dataType = "CustomerQueryRequestVO")	
 	@RequestMapping("/findByPage")
 	public Object findByPage(@RequestBody CustomerQueryRequestVO customerQueryRequestVO){
 		JsonResult result = new JsonResult();
@@ -52,10 +57,12 @@ public class CustomerController {
 	 * @param customerQueryRequestVO
 	 * @return
 	 */
+    @ApiOperation(value="根据customerId分页查询用户财富", notes = "查询用户财富列表", httpMethod = "POST",response = CustomerFortuneResponseVO.class)
+    @ApiImplicitParam(name="customerFortuneRequestVO", value="CustomerFortuneRequestVO", required = true, dataType = "CustomerFortuneRequestVO")
 	@RequestMapping("/selectByCustomerId")
-	public Object selectByCustomerId(@RequestBody CustomerFortuneRequestVO customerQueryRequestVO){
+	public Object selectByCustomerId(@RequestBody CustomerFortuneRequestVO customerFortuneRequestVO){
 		JsonResult result = new JsonResult();
-		CustomerFortuneResponseVO erpOrderQueryResponseVO = customerService.selectByCustomerId(customerQueryRequestVO);
+		CustomerFortuneResponseVO erpOrderQueryResponseVO = customerService.selectByCustomerId(customerFortuneRequestVO);
 		result.addResult(erpOrderQueryResponseVO);
 		result.setData(erpOrderQueryResponseVO);
 		return result;

--- a/yd-api/src/main/java/com/yd/api/market/MarketController.java
+++ b/yd-api/src/main/java/com/yd/api/market/MarketController.java
 package com.yd.api.market;
 import com.yd.api.result.JsonResult;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiOperation;
 import com.yd.api.market.service.MarketService;
 import com.yd.api.market.vo.announcement.AnnouncementInfoVO;
 import com.yd.api.market.vo.announcement.AnnouncementQueryRequestVO;
@@ -11,6 +16,7 @@ import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
+@Api(value="/market", tags="Market接口:")
 @RestController
 public class MarketController {
@@ -22,6 +28,8 @@ public class MarketController {
     * @param requestVO
     * @return AnnouncementQueryResponseVO
     */
+    @ApiOperation(value="按分类查询市场公告", notes = "按分类查询市场公告", httpMethod = "POST",response = AnnouncementQueryRequestVO.class)
+    @ApiImplicitParam(name="requestVO", value="AnnouncementQueryRequestVO", required = true, dataType = "AnnouncementQueryRequestVO")    
    @RequestMapping("/announcementQuery")
    public Object announcementQuery(@RequestBody AnnouncementQueryRequestVO requestVO){
        JsonResult result = new JsonResult();
@@ -35,6 +43,8 @@ public class MarketController {
     * @param announcementInfoVO
     * @return
     */
+    @ApiOperation(value="添加市场公告", notes = "添加市场公告", httpMethod = "POST",response = AnnouncementQueryRequestVO.class)
+    @ApiImplicitParam(name="announcementInfoVO", value="AnnouncementInfoVO", required = true, dataType = "AnnouncementInfoVO")        
    @RequestMapping("/addannouncement")
    public Object addAnnouncement(@RequestBody AnnouncementInfoVO announcementInfoVO){
        JsonResult result = new JsonResult();
@@ -48,6 +58,8 @@ public class MarketController {
     * @param announcementInfoVO
     * @return
     */
+    @ApiOperation(value="修改市场公告", notes = "修改市场公告", httpMethod = "POST",response = AnnouncementQueryRequestVO.class)
+    @ApiImplicitParam(name="announcementInfoVO", value="AnnouncementInfoVO", required = true, dataType = "AnnouncementInfoVO")    
    @RequestMapping("/updateannouncement")
    public Object updateAnnouncement(@RequestBody AnnouncementInfoVO announcementInfoVO){
        JsonResult result = new JsonResult();
@@ -60,6 +72,8 @@ public class MarketController {
     * @param announcementInfoVO
     * @return
     */
+    @ApiOperation(value="删除市场公告", notes = "删除市场公告", httpMethod = "POST",response = AnnouncementQueryRequestVO.class)
+    @ApiImplicitParam(name="announcementInfoVO", value="AnnouncementInfoVO", required = true, dataType = "AnnouncementInfoVO")        
    @RequestMapping("/deleteannouncement")
    public Object deleteAnnouncement(@RequestBody AnnouncementInfoVO announcementInfoVO){
        JsonResult result = new JsonResult();

--- a/yd-api/src/main/java/com/yd/api/result/JsonResult.java
+++ b/yd-api/src/main/java/com/yd/api/result/JsonResult.java
@@ -4,6 +4,8 @@ import java.io.Serializable;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
+import io.swagger.annotations.ApiModelProperty;
 //import com.ajb.config.ZHBErrorConfig;
 /***
@@ -14,8 +16,11 @@ import java.lang.reflect.Method;
 */
 public class JsonResult implements Serializable {
 	private static final long serialVersionUID = 1L;
+	@ApiModelProperty(value = "返回码：成功true, 失败false")
 	private boolean success;
+	@ApiModelProperty(value = "提示信息")
 	private String message;
+	@ApiModelProperty(value = "返回内容")
 	private Object data;
 	public  JsonResult(){}

--- a/yd-api/src/main/java/com/yd/util/config/Swagger2Config.java
+++ b/yd-api/src/main/java/com/yd/util/config/Swagger2Config.java
+package com.yd.util.config;
+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;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+/**
+ * 描述
+ *
+ */
+@Configuration
+@EnableSwagger2
+public class Swagger2Config {
+    @Bean
+    public Docket api() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .apiInfo(apiInfo())
+                .select()
+                // 自行修改为自己的包路径
+                .apis(RequestHandlerSelectors.basePackage("com.yd.api"))
+                .paths(PathSelectors.any())
+                .build();
+    }
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder()
+                .title("yd-api银盾接口文档")
+                .description("银盾接口文档说明")
+                .version("1.0")
+                .build();
+    }
+}