加入swagger 管理rest文档

order/pom.xml

@@ -9,6 +9,10 @@
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
+    <properties>
+        <swagger.version>2.7.0</swagger.version>
+    </properties>
+
     <artifactId>order</artifactId>
     <dependencies>
         <dependency>
@@ -74,6 +78,18 @@
             <groupId>org.springframework.amqp</groupId>
             <artifactId>spring-rabbit</artifactId>
         </dependency>
+        <!-- swagger2 -->
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>${swagger.version}</version>
+        </dependency>
+        <!-- swagger2 ui -->
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>${swagger.version}</version>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

order/src/main/java/club/newtech/qbike/order/OrderApplication.java

@@ -14,10 +14,12 @@
 import org.springframework.data.redis.listener.RedisMessageListenerContainer;
 import org.springframework.data.redis.listener.adapter.MessageListenerAdapter;
 import org.springframework.web.client.RestTemplate;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
 @SpringBootApplication
 @EnableDiscoveryClient
 @EnableCircuitBreaker
+@EnableSwagger2
 public class OrderApplication {
     public static void main(String[] args) {
         SpringApplication.run(OrderApplication.class, args);

order/src/main/java/club/newtech/qbike/order/SwaggerConfig.java

@@ -0,0 +1,38 @@
+package club.newtech.qbike.order;
+
+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;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+/**
+ * @Author minhao
+ * @Description  swagger config
+ * @Date
+ * @Param
+ * @return
+ **/
+@Configuration
+public class SwaggerConfig {
+    @Bean
+    public Docket createRestApi() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .apiInfo(apiInfo())
+                .select()
+                .apis(RequestHandlerSelectors.basePackage("club.newtech.qbike"))
+                .paths(PathSelectors.any())
+                .build();
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder()
+                .title("Qbike swagger 文档")
+                .version("1.0")
+                .build();
+    }
+}

order/src/main/java/club/newtech/qbike/order/controller/OrderController.java

@@ -5,22 +5,29 @@
 import club.newtech.qbike.order.domain.exception.OrderRuntimeException;
 import club.newtech.qbike.order.domain.repository.OrderRepository;
 import club.newtech.qbike.order.domain.service.FsmService;
+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.PostMapping;
+import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.RestController;
 
 import java.util.Arrays;
 import java.util.List;
 import java.util.UUID;
 
 @RestController
+@Api("订单相关接口")
 public class OrderController {
     @Autowired
     FsmService fsmService;
     @Autowired
     OrderRepository orderRepository;
 
+
     @PostMapping("/order/cancel")
+    @ApiOperation("订单取消")
     public List<String> cancelOrder(int driverId, String orderId) {
         StateRequest stateRequest = new StateRequest();
         stateRequest.setEvent(Events.CANCEL);