You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2016/12/06 11:57:49 UTC
[5/8] camel git commit: CAMEL-10561: camel-catalog - Add REST JAX-RS
application
CAMEL-10561: camel-catalog - Add REST JAX-RS application
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/59a2585c
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/59a2585c
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/59a2585c
Branch: refs/heads/master
Commit: 59a2585c0dd314711771eacc7f59def05f34daa7
Parents: 41d10de
Author: Claus Ibsen <da...@apache.org>
Authored: Tue Dec 6 11:40:27 2016 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Tue Dec 6 11:40:27 2016 +0100
----------------------------------------------------------------------
platforms/catalog-rest/pom.xml | 23 ++++++
.../camel/catalog/rest/CamelCatalogRest.java | 4 +
.../catalog/rest/CamelCatalogSwaggerTest.java | 80 ++++++++++++++++++++
3 files changed, 107 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/59a2585c/platforms/catalog-rest/pom.xml
----------------------------------------------------------------------
diff --git a/platforms/catalog-rest/pom.xml b/platforms/catalog-rest/pom.xml
index e1e7e45..df6c625 100644
--- a/platforms/catalog-rest/pom.xml
+++ b/platforms/catalog-rest/pom.xml
@@ -43,6 +43,23 @@
<version>${javax.ws.rs-api-version}</version>
</dependency>
+ <!-- swagger -->
+ <dependency>
+ <groupId>io.swagger</groupId>
+ <artifactId>swagger-core</artifactId>
+ <version>${swagger-java-version}</version>
+ </dependency>
+ <dependency>
+ <groupId>io.swagger</groupId>
+ <artifactId>swagger-annotations</artifactId>
+ <version>${swagger-java-version}</version>
+ </dependency>
+ <dependency>
+ <groupId>io.swagger</groupId>
+ <artifactId>swagger-jaxrs</artifactId>
+ <version>${swagger-java-version}</version>
+ </dependency>
+
<!-- cxf -->
<dependency>
<groupId>org.apache.cxf</groupId>
@@ -68,6 +85,12 @@
<version>${cxf-version}</version>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-rt-rs-service-description-swagger</artifactId>
+ <version>${cxf-version}</version>
+ <scope>test</scope>
+ </dependency>
<!-- to support json -->
<dependency>
http://git-wip-us.apache.org/repos/asf/camel/blob/59a2585c/platforms/catalog-rest/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRest.java
----------------------------------------------------------------------
diff --git a/platforms/catalog-rest/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRest.java b/platforms/catalog-rest/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRest.java
index e2466d9..4b54ee8 100644
--- a/platforms/catalog-rest/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRest.java
+++ b/platforms/catalog-rest/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRest.java
@@ -23,12 +23,15 @@ import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
import org.apache.camel.catalog.CamelCatalog;
import org.apache.camel.catalog.DefaultCamelCatalog;
/**
* A REST based {@link CamelCatalog} service as a JAX-RS resource class.
*/
+@Api(value = "/camel-catalog", description = "Camel Catalog REST API")
@Path("/camel-catalog")
public class CamelCatalogRest {
@@ -50,6 +53,7 @@ public class CamelCatalogRest {
*/
@GET
@Path("/catalogVersion")
+ @ApiOperation(value = "The version of this Camel Catalog")
public String getCatalogVersion() {
return catalog.getCatalogVersion();
}
http://git-wip-us.apache.org/repos/asf/camel/blob/59a2585c/platforms/catalog-rest/src/test/java/org/apache/camel/catalog/rest/CamelCatalogSwaggerTest.java
----------------------------------------------------------------------
diff --git a/platforms/catalog-rest/src/test/java/org/apache/camel/catalog/rest/CamelCatalogSwaggerTest.java b/platforms/catalog-rest/src/test/java/org/apache/camel/catalog/rest/CamelCatalogSwaggerTest.java
new file mode 100644
index 0000000..339040f
--- /dev/null
+++ b/platforms/catalog-rest/src/test/java/org/apache/camel/catalog/rest/CamelCatalogSwaggerTest.java
@@ -0,0 +1,80 @@
+/**
+ * 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.
+ */
+package org.apache.camel.catalog.rest;
+
+import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider;
+import org.apache.camel.test.AvailablePortFinder;
+import org.apache.cxf.endpoint.Server;
+import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;
+import org.apache.cxf.jaxrs.lifecycle.SingletonResourceProvider;
+import org.apache.cxf.jaxrs.swagger.Swagger2Feature;
+import org.hamcrest.Matchers;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import static io.restassured.RestAssured.given;
+
+public class CamelCatalogSwaggerTest {
+
+ private Server server;
+ private CamelCatalogRest catalog;
+ private int port;
+
+ @Before
+ public void setup() {
+ catalog = new CamelCatalogRest();
+
+ port = AvailablePortFinder.getNextAvailable(9000);
+
+ // setup Apache CXF REST server
+ JAXRSServerFactoryBean sf = new JAXRSServerFactoryBean();
+ sf.setResourceClasses(CamelCatalogRest.class);
+ sf.setResourceProvider(CamelCatalogRest.class, new SingletonResourceProvider(catalog));
+
+ Swagger2Feature swagger = new Swagger2Feature();
+ swagger.setBasePath("/");
+ swagger.setScanAllResources(false);
+ swagger.setPrettyPrint(true);
+ sf.getFeatures().add(swagger);
+
+ // to use jackson for json
+ sf.setProvider(JacksonJsonProvider.class);
+ sf.setAddress("http://localhost:" + port);
+
+ // create and start the CXF server (non blocking)
+ server = sf.create();
+ server.start();
+ }
+
+ @After
+ public void stop() {
+ if (server != null) {
+ server.stop();
+ }
+ }
+
+ @Test
+ public void testSwagger() throws Exception {
+ given().
+ baseUri("http://localhost:" + port).
+ when().
+ get("/swagger.json").
+ then().
+ body("paths./camel-catalog/catalogVersion.get.summary", Matchers.is("The version of this Camel Catalog"));
+ }
+}