[example]add swagger sample project to test the relevant functionality of the API documentation.

shenyu-examples/pom.xml

@@ -38,11 +38,13 @@
         <versions-maven-plugin.version>2.5</versions-maven-plugin.version>
         <docker-maven-plugin.version>0.40.1</docker-maven-plugin.version>
         <maven-checkstyle-plugin.version>3.1.0</maven-checkstyle-plugin.version>
+        <swagger.version>2.9.2</swagger.version>
     </properties>
 
     <modules>
         <module>shenyu-examples-common</module>
         <module>shenyu-examples-http</module>
+        <module>shenyu-examples-http-swagger2</module>
         <module>shenyu-examples-https</module>
         <module>shenyu-examples-dubbo</module>
         <module>shenyu-examples-springcloud</module>
@@ -59,6 +61,22 @@
         <module>shenyu-examples-brpc</module>
     </modules>
 
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>io.springfox</groupId>
+                <artifactId>springfox-swagger2</artifactId>
+                <version>${swagger.version}</version>
+            </dependency>
+
+            <dependency>
+                <groupId>io.springfox</groupId>
+                <artifactId>springfox-swagger-ui</artifactId>
+                <version>${swagger.version}</version>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
     <build>
         <plugins>
             <plugin>

shenyu-examples/shenyu-examples-http-swagger2/Dockerfile

@@ -0,0 +1,29 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM openjdk:8-jre-alpine
+
+ENV APP_NAME shenyu-examples-http-swagger2
+ENV LOCAL_PATH /opt/${APP_NAME}
+
+RUN mkdir -p ${LOCAL_PATH}
+
+ADD target/${APP_NAME}.jar ${LOCAL_PATH}
+
+WORKDIR ${LOCAL_PATH}
+EXPOSE 8190
+
+CMD java -jar ${APP_NAME}.jar

shenyu-examples/shenyu-examples-http-swagger2/k8s/script/healthcheck.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+PRGDIR=`dirname "$0"`
+for service in `grep -v -E "^$|^#" ${PRGDIR}/services.list`
+do
+    for loop in `seq 1 30`
+    do
+        status=`curl -o /dev/null -s -w %{http_code} $service`
+        echo -e "curl $service response $status"
+
+        if [ $status -eq 200  ]; then
+            break
+        fi
+
+        sleep 2
+    done
+done
+
+sleep 5
+
+status=`curl -s -o /dev/null -w "%{http_code}" -X POST -H "Content-Type:application/json" http://localhost:31195/http/order/save --data '{"name":"test", "id": 123}'`
+
+sleep 3
+
+if [ $status -eq 200 ]; then
+    echo -e "Success to send request: $status"
+    echo -e "\n-------------------"
+    exit 0
+fi
+echo -e "Failed to send request from shenyu-bootstrap to http example: $status"
+echo -e "\n-------------------"
+exit 1

shenyu-examples/shenyu-examples-http-swagger2/k8s/script/services.list

@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+http://localhost:31095/actuator/health
+http://localhost:31195/actuator/health
+http://localhost:31189/test/path/123?name=tom

shenyu-examples/shenyu-examples-http-swagger2/k8s/shenyu-deployment.yml

@@ -0,0 +1,82 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: shenyu-admin
+  labels:
+    app: shenyu-admin
+    all: shenyu-examples-http-swagger2
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: shenyu-admin
+      all: shenyu-examples-http-swagger2
+  template:
+    metadata:
+      labels:
+        app: shenyu-admin
+        all: shenyu-examples-http-swagger2
+    spec:
+      containers:
+        - name: shenyu-admin
+          image: apache/shenyu-admin:latest
+          resources: {}
+          env:
+            - name: SPRING_PROFILES_ACTIVE
+              value: h2
+            - name: shenyu.database.init_script
+              value: sql-script/h2/schema.sql
+          ports:
+            - containerPort: 9095
+          imagePullPolicy: IfNotPresent
+      restartPolicy: Always
+status: {}
+
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: shenyu-bootstrap
+  labels:
+    app: shenyu-bootstrap
+    all: shenyu-examples-http-swagger2
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: shenyu-bootstrap
+      all: shenyu-examples-http-swagger2
+  template:
+    metadata:
+      labels:
+        app: shenyu-bootstrap
+        all: shenyu-examples-http-swagger2
+    spec:
+      containers:
+        - name: shenyu-bootstrap
+          image: apache/shenyu-bootstrap:latest
+          resources: {}
+          env:
+            - name: shenyu.sync.websocket.urls
+              value: ws://shenyu-admin:9095/websocket
+          ports:
+            - containerPort: 9195
+          imagePullPolicy: IfNotPresent
+      restartPolicy: Always
+status: {}

shenyu-examples/shenyu-examples-http-swagger2/k8s/shenyu-examples-http-deployment.yml

@@ -0,0 +1,91 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: shenyu-examples-http-swagger2-deployment
+  labels:
+    app: shenyu-examples-http-swagger2
+    all: shenyu-examples-http-swagger2
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: shenyu-examples-http-swagger2
+      all: shenyu-examples-http-swagger2
+  strategy: {}
+  template:
+    metadata:
+      labels:
+        app: shenyu-examples-http-swagger2
+        all: shenyu-examples-http-swagger2
+    spec:
+      containers:
+        - image: shenyu-examples-http-swagger2
+          name: shenyu-examples-http-swagger2
+          livenessProbe:
+            exec:
+              command:
+                - wget -q -O - http://localhost:8190/actuator/health | grep UP || exit 1
+            initialDelaySeconds: 10
+            failureThreshold: 3
+            timeoutSeconds: 2
+          env:
+            - name: shenyu.register.serverLists
+              value: http://shenyu-admin:9095
+          ports:
+            - containerPort: 8190
+          imagePullPolicy: IfNotPresent
+      restartPolicy: Always
+status: {}
+
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  labels:
+    app: shenyu-zk
+    all: shenyu-examples-http-swagger2
+  name: shenyu-zk
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: shenyu-zk
+      all: shenyu-examples-http-swagger2
+  strategy: {}
+  template:
+    metadata:
+      labels:
+        app: shenyu-zk
+        all: shenyu-examples-http-swagger2
+    spec:
+      containers:
+        - image: zookeeper:3.5
+          name: shenyu-zk
+          resources: {}
+          ports:
+            - containerPort: 2181
+              name: client
+            - containerPort: 2888
+              name: server
+            - containerPort: 3888
+              name: leader-election
+            - containerPort: 8080
+              name: website
+      restartPolicy: Always
+status: {}

shenyu-examples/shenyu-examples-http-swagger2/k8s/shenyu-examples-http-service.yml

@@ -0,0 +1,62 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+apiVersion: v1
+kind: Service
+metadata:
+  name: shenyu-examples-http-swagger2-service
+  labels:
+    app: shenyu-examples-http-swagger2
+    all: shenyu-examples-http-swagger2
+spec:
+  selector:
+    app: shenyu-examples-http-swagger2
+    all: shenyu-examples-http-swagger2
+  type: NodePort
+  ports:
+  - name: "8190"
+    port: 8190
+    targetPort: 8190
+    nodePort: 31189
+status:
+  loadBalancer: {}
+
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: shenyu-zk
+  labels:
+    app: shenyu-zk
+    all: shenyu-examples-http-swagger2
+spec:
+  type: NodePort
+  selector:
+    app: shenyu-zk
+    all: shenyu-examples-http-swagger2
+  ports:
+    - name: "client"
+      port: 2181
+      targetPort: 2181
+    - name: "server"
+      port: 2888
+      targetPort: 2888
+    - name: "election"
+      port: 3888
+      targetPort: 3888
+    - name: "website"
+      port: 8080
+      targetPort: 8080