();
+ }
+ enumVar.add(string);
+ }
+
+ public String getDefault() {
+ return defaultValue;
+ }
+
+ public void setDefault(String defaultValue) {
+ this.defaultValue = defaultValue;
+ }
+
+ public String getDescription() {
+ return description;
+ }
+
+ public void setDescription(String description) {
+ this.description = description;
+ }
+}
diff --git a/swagger/src/main/java/com/strategicgains/restexpress/plugin/swagger/wrapper/Tag.java b/swagger/src/main/java/com/strategicgains/restexpress/plugin/swagger/wrapper/Tag.java
new file mode 100644
index 0000000..01530f7
--- /dev/null
+++ b/swagger/src/main/java/com/strategicgains/restexpress/plugin/swagger/wrapper/Tag.java
@@ -0,0 +1,34 @@
+package com.strategicgains.restexpress.plugin.swagger.wrapper;
+
+/**
+ * @see https://swagger.io/specification/#tagObject
+ */
+public class Tag {
+ private String name;
+ private String description;
+ private ExternalDocumentation externalDocs;
+
+ public String getName() {
+ return name;
+ }
+
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ public String getDescription() {
+ return description;
+ }
+
+ public void setDescription(String description) {
+ this.description = description;
+ }
+
+ public ExternalDocumentation getExternalDocs() {
+ return externalDocs;
+ }
+
+ public void setExternalDocs(ExternalDocumentation externalDocs) {
+ this.externalDocs = externalDocs;
+ }
+}
\ No newline at end of file
diff --git a/swagger/src/main/java/com/strategicgains/restexpress/plugin/swagger/wrapper/XmlObject.java b/swagger/src/main/java/com/strategicgains/restexpress/plugin/swagger/wrapper/XmlObject.java
new file mode 100644
index 0000000..690069b
--- /dev/null
+++ b/swagger/src/main/java/com/strategicgains/restexpress/plugin/swagger/wrapper/XmlObject.java
@@ -0,0 +1,52 @@
+package com.strategicgains.restexpress.plugin.swagger.wrapper;
+
+/**
+ * @see https://swagger.io/specification/#xmlObject
+ */
+public class XmlObject {
+ private String name;
+ private String namespace;
+ private String prefix;
+ private Boolean attribute;
+ private Boolean wrapped;
+
+ public String getName() {
+ return name;
+ }
+
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ public String getNamespace() {
+ return namespace;
+ }
+
+ public void setNamespace(String namespace) {
+ this.namespace = namespace;
+ }
+
+ public String getPrefix() {
+ return prefix;
+ }
+
+ public void setPrefix(String prefix) {
+ this.prefix = prefix;
+ }
+
+ public Boolean getAttribute() {
+ return attribute;
+ }
+
+ public void setAttribute(Boolean attribute) {
+ this.attribute = attribute;
+ }
+
+ public Boolean getWrapped() {
+ return wrapped;
+ }
+
+ public void setWrapped(Boolean wrapped) {
+ this.wrapped = wrapped;
+ }
+}
\ No newline at end of file
diff --git a/swagger/src/main/java/io/swagger/oas/annotations/Hidden.java b/swagger/src/main/java/io/swagger/oas/annotations/Hidden.java
new file mode 100644
index 0000000..f02a0a0
--- /dev/null
+++ b/swagger/src/main/java/io/swagger/oas/annotations/Hidden.java
@@ -0,0 +1,13 @@
+package io.swagger.oas.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+
+@Target(value={ElementType.METHOD,ElementType.TYPE,ElementType.FIELD})
+@Retention(value=RetentionPolicy.RUNTIME)
+public @interface Hidden {
+
+}
diff --git a/swagger/src/main/java/io/swagger/oas/annotations/Operation.java b/swagger/src/main/java/io/swagger/oas/annotations/Operation.java
new file mode 100644
index 0000000..6454282
--- /dev/null
+++ b/swagger/src/main/java/io/swagger/oas/annotations/Operation.java
@@ -0,0 +1,118 @@
+/**
+ * Copyright 2017 SmartBear Software
+ *
+ * Licensed 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.
+ *
+ *
+ * https://raw.githubusercontent.com/swagger-api/swagger-core/bugfix/requestBody-Annotation/modules/swagger-annotations/src/main/java/io/swagger/oas/annotations/Operation.java
+ */
+
+package io.swagger.oas.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import io.swagger.oas.annotations.extensions.Extension;
+import io.swagger.oas.annotations.parameters.RequestBody;
+import io.swagger.oas.annotations.responses.ApiResponse;
+import io.swagger.oas.annotations.security.SecurityRequirement;
+import io.swagger.oas.annotations.servers.Server;
+
+/**
+ * Describes a single API operation on a path.
+ **/
+@Target({ElementType.METHOD})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+public @interface Operation {
+ /**
+ * The HTTP method for this operation.
+ * @return the HTTP method of this operation
+ **/
+ String method() default "";
+
+ /**
+ * Tags can be used for logical grouping of operations by resources or any other qualifier.
+ * @return the list of tags associated with this operation
+ **/
+ String[] tags() default {};
+
+ /**
+ * Provides a brief description of this operation. Should be 120 characters or less for proper visibility in Swagger-UI.
+ * @return a summary of this operation
+ **/
+ String summary() default "";
+
+ /**
+ * A verbose description of the operation.
+ * @return a description of this operation
+ **/
+ String description() default "";
+
+ /**
+ * Additional external documentation for this operation.
+ * @return additional documentation about this operation
+ **/
+ ExternalDocumentation externalDocs() default @ExternalDocumentation();
+
+ /**
+ * The operationId is used by third-party tools to uniquely identify this operation.
+ * @return the ID of this operation
+ **/
+ String operationId() default "";
+
+ /**
+ * An optional array of parameters which will be added to any automatically detected parameters in the method itself.
+ * @return the list of parameters for this operation
+ **/
+ Parameter[] parameters() default {};
+
+ /**
+ * The request body applicable for this operation.
+ * @return the requesty body of this operation
+ **/
+ RequestBody requestBody() default @RequestBody();
+
+ /**
+ * A declaration of which security mechanisms can be used for this operation.
+ * @return the array of security requirements for this Operation
+ */
+ SecurityRequirement[] security() default {};
+
+ /**
+ * The list of possible responses as they are returned from executing this operation.
+ * @return the list of responses for this operation
+ **/
+ ApiResponse[] responses() default {};
+
+ /**
+ * Allows an operation to be marked as deprecated. Alternatively use the @Deprecated annotation
+ * @return whether or not this operation is deprecated
+ **/
+ boolean deprecated() default false;
+
+ /**
+ * An alternative server array to service this operation.
+ * @return the list of servers hosting this operation
+ **/
+ Server[] servers() default {};
+
+ /**
+ * The list of optional extensions
+ * @return an optional array of extensions
+ */
+ Extension[] extensions() default {};
+}
\ No newline at end of file
diff --git a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/Another.java b/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/Another.java
deleted file mode 100644
index 439c6fc..0000000
--- a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/Another.java
+++ /dev/null
@@ -1,35 +0,0 @@
-/*
- Copyright 2014, Strategic Gains, Inc.
-
- Licensed 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 com.strategicgains.restexpress.plugin.swagger;
-
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
-
-/**
- * @author toddf
- * @since Apr 1, 2014
- */
-public class Another
-{
- private String aString;
- private int anInt;
- private Integer[] intArray;
- private Map mapStringString;
- private Map mapObjectObject;
- private List listDummyModel;
- Collection anothers;
-}
diff --git a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/AnotherReturnType.java b/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/AnotherReturnType.java
deleted file mode 100644
index bd82e0f..0000000
--- a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/AnotherReturnType.java
+++ /dev/null
@@ -1,27 +0,0 @@
-/*
- Copyright 2014, Strategic Gains, Inc.
-
- Licensed 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 com.strategicgains.restexpress.plugin.swagger;
-
-/**
- *
- * @author uritzry
- * @since Aug 20, 2014
- */
-public class AnotherReturnType {
-
- private String someValue;
-
-}
diff --git a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/DummyBase.java b/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/DummyBase.java
deleted file mode 100644
index fe7a523..0000000
--- a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/DummyBase.java
+++ /dev/null
@@ -1,6 +0,0 @@
-package com.strategicgains.restexpress.plugin.swagger;
-
-public abstract class DummyBase {
- private String base1;
- private int base2;
-}
diff --git a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/DummyController.java b/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/DummyController.java
deleted file mode 100644
index c03ea39..0000000
--- a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/DummyController.java
+++ /dev/null
@@ -1,117 +0,0 @@
-/*
- Copyright 2013, Strategic Gains, Inc.
-
- Licensed 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 com.strategicgains.restexpress.plugin.swagger;
-
-import java.util.List;
-
-import org.restexpress.Request;
-import org.restexpress.Response;
-
-import com.strategicgains.restexpress.plugin.swagger.annotations.ApiModelRequest;
-import com.wordnik.swagger.annotations.ApiImplicitParam;
-import com.wordnik.swagger.annotations.ApiImplicitParams;
-import com.wordnik.swagger.annotations.ApiOperation;
-import com.wordnik.swagger.annotations.ApiParam;
-import com.wordnik.swagger.annotations.ApiResponse;
-import com.wordnik.swagger.annotations.ApiResponses;
-
-/**
- * @author toddf
- * @since Nov 22, 2013
- */
-public class DummyController
-{
- public DummyModel read(Request request, Response response)
- {
- return null;
- }
-
- public List readAll(Request request, Response response)
- {
- return null;
- }
-
- @ApiModelRequest(model=DummyModel.class, required=true)
- public void create(Request request, Response response)
- {
- response.setResponseCreated();
- }
-
- public void update(Request request, Response response)
- {
- }
-
- public void delete(Request request, Response response)
- {
- response.setResponseNoContent();
- }
-
- public void health(Request request, Response response)
- {
- }
-
- public void options(Request request, Response response)
- {
- }
-
- public Another readAnother(Request request, Response response)
- {
- return null;
- }
-
- @ApiOperation(value = "hidden.", hidden = true,
- notes = "More detailed description here. hidden",
- response = Another.class)
- public AnotherReturnType thisIsAHiddenAPI(Request request, Response response)
- {
- return null;
- }
-
- @ApiOperation(value = "Read with Annotations.",
- notes = "More detailed description here.",
- response = Another.class)
- public AnotherReturnType readWithApiOperationAnnotation(Request request, Response response)
- {
- return null;
- }
-
- @ApiResponses({
- @ApiResponse(code = 204, message = "Successful update"),
- @ApiResponse(code = 404, message = "Item not found"),
- @ApiResponse(code = 400, message = "Item id incorrect format")})
- public void updateWithApiResponse(Request request, Response response)
- {
- }
-
- @ApiImplicitParams({
- @ApiImplicitParam(name = "expand", required = false, value = "(Optional) Return item and all its children.", paramType = "query", dataType = "String", allowableValues = "all, some, none"),
- @ApiImplicitParam(name = "title", required = true, value = "(Required) Title of the item.", paramType = "body", dataType = "String", allowableValues = "Any string"),
- })
- public void createWithApiImplicitParams(Request request, Response response)
- {
- }
-
- @ApiParam(name = "title", required = true, value = "(Required) Title of the item.", defaultValue = "Title placeholder", allowableValues = "Any String")
- public void createWithApiParam(Request request, Response response)
- {
- }
-
- @ApiModelRequest(model=DummyModel.class, modelName="AlternativeDummyModel")
- public void createWithApiModelRequest(Request request, Response response)
- {
- }
-
-}
diff --git a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/DummyModel.java b/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/DummyModel.java
deleted file mode 100644
index f5f0966..0000000
--- a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/DummyModel.java
+++ /dev/null
@@ -1,56 +0,0 @@
-package com.strategicgains.restexpress.plugin.swagger;
-
-import com.wordnik.swagger.annotations.ApiModel;
-import com.strategicgains.restexpress.plugin.swagger.annotations.ApiModelProperty;
-
-import java.math.BigDecimal;
-import java.util.List;
-
-@com.wordnik.swagger.annotations.ApiModel
-public class DummyModel extends DummyBase {
- @ApiModel
- public static class One extends Base {
- private String prop1;
- private String prop2;
- }
-
- public static class Base {
- @ApiModelProperty(position = -1)
- private String base1;
- @ApiModelProperty(position = -2)
- private String base2;
- }
-
- public enum ColorEnum {
- RED,
- GREEN,
- BLUE
- }
-
- @ApiModelProperty
- private List ones;
- @ApiModelProperty
- private String dummy1;
- @ApiModelProperty
- private int dummy2;
- private transient String transient1;
- private static int static1;
- @ApiModelProperty
- private float dummy3;
- @ApiModelProperty
- private boolean dummy4;
- @ApiModelProperty
- private One[] dummy5;
- @ApiModelProperty
- private int[] dummy6;
- @ApiModelProperty
- private Integer dummy7;
- @ApiModelProperty
- private Double dummy8;
- @ApiModelProperty
- private ColorEnum color;
- @ApiModelProperty(dataType = "number")
- private BigDecimal dummy9;
- @ApiModelProperty(dataType = "number", format = "double", excludeFromModels = {"AlternativeDummyModel"})
- private BigDecimal dummy10;
-}
diff --git a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/ModelResolverTest.java b/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/ModelResolverTest.java
deleted file mode 100644
index 0b8871c..0000000
--- a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/ModelResolverTest.java
+++ /dev/null
@@ -1,97 +0,0 @@
-/*
- Copyright 2014, Strategic Gains, Inc.
-
- Licensed 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 com.strategicgains.restexpress.plugin.swagger;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-
-import java.lang.reflect.Type;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-
-import org.junit.Test;
-
-import com.strategicgains.restexpress.plugin.swagger.domain.DataType;
-
-/**
- * @author russtrotter
- */
-public class ModelResolverTest
-{
- private ModelResolver builder = new ModelResolver();
-
- @Test
- public void shouldResolveDummyModel()
- {
- DataType n = builder.resolve(DummyModel.class);
- assertNotNull(n);
- assertEquals(DummyModel.class.getSimpleName(), n.getRef());
- }
-
- @Test
- public void shouldResolveDummyModelArray()
- {
- DataType n = builder.resolve(DummyModel[].class);
- assertNotNull(n);
- assertEquals("array", n.getType());
- assertEquals(DummyModel.class.getSimpleName(), n.getItems().getRef());
- }
-
-// @Test
-// public void shouldResolveDummyModelArrayList()
-// {
-// List list = new ArrayList();
-// DataType n = builder.resolve(list.getClass());
-// assertNotNull(n);
-// assertEquals("array", n.getType());
-// assertEquals(DummyModel.class.getSimpleName(), n.getItems().getRef());
-// }
-
- @Test
- public void shouldResolveAnother()
- {
- DataType n = builder.resolve(Another.class);
- assertNotNull(n);
- assertEquals(Another.class.getSimpleName(), n.getRef());
- }
-
- @Test
- public void shouldResolveAnotherArray()
- {
- DataType n = builder.resolve(Another[].class);
- assertNotNull(n);
- assertEquals("array", n.getType());
- assertEquals(Another.class.getSimpleName(), n.getItems().getRef());
- }
-
-// @Test
-// public void shouldResolveAnotherArrayList()
-// {
-// DataType n = builder.resolve(new ArrayList().getClass());
-// assertNotNull(n);
-// assertEquals("array", n.getType());
-// assertEquals(Another.class.getSimpleName(), n.getItems().getRef());
-// }
-
- @Test
- public void shouldResolveAnotherMap()
- {
- DataType n = builder.resolve(new HashMap().getClass());
- assertNotNull(n);
- assertEquals("object", n.getType());
- }
-}
diff --git a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/SwaggerAssert.java b/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/SwaggerAssert.java
deleted file mode 100644
index 548ec0c..0000000
--- a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/SwaggerAssert.java
+++ /dev/null
@@ -1,37 +0,0 @@
-/*
- Copyright 2014, Strategic Gains, Inc.
-
- Licensed 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 com.strategicgains.restexpress.plugin.swagger;
-
-import static org.hamcrest.Matchers.equalTo;
-
-import com.jayway.restassured.http.ContentType;
-import com.jayway.restassured.response.Response;
-
-/**
- * @author toddf
- * @since Apr 4, 2014
- */
-public class SwaggerAssert
-{
- public static void common(Response response)
- {
- response
- .then()
- .contentType(ContentType.JSON)
- .body("apiVersion", equalTo("1.0"))
- .body("swaggerVersion", equalTo("1.2"));
- }
-}
diff --git a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/SwaggerPluginTest.java b/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/SwaggerPluginTest.java
deleted file mode 100644
index 7dcd4c0..0000000
--- a/swagger/src/test/java/com/strategicgains/restexpress/plugin/swagger/SwaggerPluginTest.java
+++ /dev/null
@@ -1,430 +0,0 @@
-/*
- Copyright 2013, Strategic Gains, Inc.
-
- Licensed 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 com.strategicgains.restexpress.plugin.swagger;
-
-import static com.jayway.restassured.RestAssured.*;
-import static org.hamcrest.Matchers.*;
-import static org.junit.Assert.*;
-
-import java.io.IOException;
-import java.util.List;
-
-import org.apache.http.HttpEntity;
-import org.apache.http.HttpResponse;
-import org.apache.http.client.ClientProtocolException;
-import org.apache.http.client.HttpClient;
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.impl.client.DefaultHttpClient;
-import org.apache.http.util.EntityUtils;
-import io.netty.handler.codec.http.HttpMethod;
-import org.junit.AfterClass;
-import org.junit.BeforeClass;
-import org.junit.Test;
-import org.restexpress.RestExpress;
-
-import com.jayway.restassured.RestAssured;
-import com.jayway.restassured.response.Response;
-
-/**
- * @author toddf
- * @since Nov 22, 2013
- */
-public class SwaggerPluginTest
-{
- private static final RestExpress SERVER = new RestExpress();
- private static final int PORT = 9001;
- private static final String BASE_URL = "http://localhost:" + PORT;
- private HttpClient http = new DefaultHttpClient();
-
- @BeforeClass
- public static void intialize()
- {
- RestAssured.port = PORT;
-
- DummyController controller = new DummyController();
- SERVER.setBaseUrl(BASE_URL);
-
- SERVER.uri("/", controller)
- .action("health", HttpMethod.GET)
- .name("root");
-
- SERVER.uri("/anothers/{userId}", controller)
- .action("readAnother", HttpMethod.GET);
-
- SERVER.uri("/users.{format}", controller)
- .action("readAll", HttpMethod.GET)
- .action("options", HttpMethod.OPTIONS)
- .method(HttpMethod.POST)
- .name("Users Collection");
-
- SERVER.uri("/users/{userId}.{format}", controller)
- .method(HttpMethod.GET, HttpMethod.PUT, HttpMethod.DELETE)
- .action("options", HttpMethod.OPTIONS)
- .name("Individual User");
-
- SERVER.uri("/users/{userId}/orders.{format}", controller)
- .action("readAll", HttpMethod.GET)
- .method(HttpMethod.POST)
- .name("User Orders Collection");
-
- SERVER.uri("/orders.{format}", controller)
- .action("readAll", HttpMethod.GET)
- .method(HttpMethod.POST)
- .name("Orders Collection");
-
- SERVER.uri("/orders/{orderId}.{format}", controller)
- .method(HttpMethod.GET, HttpMethod.PUT, HttpMethod.DELETE)
- .name("Individual Order");
-
- SERVER.uri("/orders/{orderId}/items.{format}", controller)
- .action("readAll", HttpMethod.GET)
- .method(HttpMethod.POST)
- .name("Order Line-Items Collection");
-
- SERVER.uri("/orders/{orderId}/items/{itemId}.{format}", controller)
- .method(HttpMethod.GET, HttpMethod.PUT, HttpMethod.DELETE)
- .name("Individual Order Line-Item");
-
- SERVER.uri("/products.{format}", controller)
- .action("readAll", HttpMethod.GET)
- .method(HttpMethod.POST)
- .name("Orders Collection");
-
- SERVER.uri("/products/{orderId}.{format}", controller)
- .method(HttpMethod.GET, HttpMethod.PUT, HttpMethod.DELETE)
- .name("Individual Order");
-
- SERVER.uri("/health", controller)
- .flag("somevalue")
- .action("health", HttpMethod.GET)
- .name("health");
-
- SERVER.uri("/nicknametest", controller)
- .method(HttpMethod.GET)
- .name(" |nickName sh0uld_str1p-CHARS$. ");
-
- SERVER.uri("/annotations/{userId}/users", controller)
- .action("readWithApiOperationAnnotation", HttpMethod.GET)
- .method(HttpMethod.GET)
- .name("Read with Annotations");
-
- SERVER.uri("/annotations/hidden", controller)
- .action("thisIsAHiddenAPI", HttpMethod.GET)
- .method(HttpMethod.GET)
- .name("thisIsAHiddenAPI");
-
- SERVER.uri("/annotations/{userId}", controller)
- .action("updateWithApiResponse", HttpMethod.PUT)
- .method(HttpMethod.PUT)
- .name("Update with Annotations");
-
- SERVER.uri("/annotations/{userId}/users/list", controller)
- .action("createWithApiImplicitParams", HttpMethod.POST)
- .method(HttpMethod.POST)
- .name("Create with Implicit Params");
-
- SERVER.uri("/annotations/{userId}/users/newlist", controller)
- .action("createWithApiParam", HttpMethod.POST)
- .method(HttpMethod.POST)
- .name("Create with Api Param");
-
- SERVER.uri("/annotations/{userId}/users/list2", controller)
- .action("createWithApiModelRequest", HttpMethod.POST)
- .method(HttpMethod.POST)
- .name("Create with Implicit Params");
-
- new SwaggerPlugin()
- .apiVersion("1.0")
- .swaggerVersion("1.2")
- .flag("flag1")
- .flag("flag2")
- .parameter("parm1", "value1")
- .parameter("parm2", "value2")
- .register(SERVER);
-
- SERVER.bind(PORT);
- }
-
- @AfterClass
- public static void shutdown()
- {
- SERVER.shutdown();
- }
-
- @Test
- public void shouldReturnApiResources()
- throws Exception
- {
- Response r = get("/api-docs");
- SwaggerAssert.common(r);
- r.then()
- .body("apis", not(hasItem(hasEntry("path", "/"))))
- .body("apis", hasItem(hasEntry("path", "/anothers")))
- .body("apis", hasItem(hasEntry("path", "/users")))
- .body("apis", hasItem(hasEntry("path", "/orders")))
- .body("apis", hasItem(hasEntry("path", "/products")))
- .body("apis", hasItem(hasEntry("path", "/health")))
- .body("apis", hasItem(hasEntry("path", "/annotations")))
- .body("apis", not(hasItem(hasEntry("path", "/api-docs"))));
- }
-
- @Test
- public void shouldReturnUsersApi()
- {
- Response r = get("/api-docs/users");
- SwaggerAssert.common(r);
- r.then()
- .body("basePath", equalTo(BASE_URL))
- .body("resourcePath", is("/users"));
-
- r.then()
- .root("apis[%s].%s")
- .body(withArgs(0, "path"), is("/users"))
- .body(withArgs(0, "description"), is("Users Collection"))
- .body(withArgs(0, "operations"), hasItem(hasEntry("method", "GET")))
- .body(withArgs(0, "operations"), hasItem(hasEntry("method", "POST")))
- .body(withArgs(0, "operations"), not(hasItem(hasEntry("method", "PUT"))))
- .body(withArgs(0, "operations"), not(hasItem(hasEntry("method", "DELETE"))))
-
-// .body(withArgs(1, "path"), is("/users/{userId}.{format}"))
- .body(withArgs(1, "path"), is("/users/{userId}"))
- .body(withArgs(1, "description"), is("Individual User"))
- .body(withArgs(1, "operations"), hasItem(hasEntry("method", "GET")))
- .body(withArgs(1, "operations"), hasItem(hasEntry("method", "PUT")))
- .body(withArgs(1, "operations"), hasItem(hasEntry("method", "DELETE")))
- .body(withArgs(1, "operations"), not(hasItem(hasEntry("method", "POST"))))
-
-// .body(withArgs(2, "path"), is("/users/{userId}/orders.{format}"))
- .body(withArgs(2, "path"), is("/users/{userId}/orders"))
- .body(withArgs(2, "description"), is("User Orders Collection"))
- .body(withArgs(2, "operations"), hasItem(hasEntry("method", "GET")))
- .body(withArgs(2, "operations"), hasItem(hasEntry("method", "POST")))
- .body(withArgs(2, "operations"), not(hasItem(hasEntry("method", "PUT"))))
- .body(withArgs(2, "operations"), not(hasItem(hasEntry("method", "DELETE"))));
- }
-
- @Test
- public void testApiUsersRoute()
- throws ClientProtocolException, IOException
- {
- HttpGet request = new HttpGet("http://localhost:9001/api-docs/users");
- HttpResponse response = (HttpResponse) http.execute(request);
- HttpEntity entity = response.getEntity();
- String json = EntityUtils.toString(entity);
- assertTrue(json.contains("\"apiVersion\":\"1.0\""));
- assertTrue(json.contains("\"swaggerVersion\":\"1.2\""));
- assertTrue(json.contains("\"basePath\":\"http://localhost:9001\""));
- assertTrue(json.contains("\"resourcePath\":\"/users\""));
- assertTrue(json.contains("\"nickname\":\"GETUsersCollection\""));
- assertTrue(json.contains("\"nickname\":\"POSTUsersCollection\""));
- assertFalse(json.contains("\"nickname\":\"OPTIONSUsersCollection\""));
- assertTrue(json.contains("\"nickname\":\"GETIndividualUser\""));
- assertTrue(json.contains("\"nickname\":\"PUTIndividualUser\""));
- assertTrue(json.contains("\"nickname\":\"DELETEIndividualUser\""));
- assertFalse(json.contains("\"nickname\":\"OPTIONSIndividualUser\""));
- assertTrue(json.contains("\"summary\":\"\""));
- request.releaseConnection();
- }
-
- @Test
- public void testApiOrdersRoute()
- throws ClientProtocolException, IOException
- {
- HttpGet request = new HttpGet("http://localhost:9001/api-docs/orders");
- HttpResponse response = (HttpResponse) http.execute(request);
- HttpEntity entity = response.getEntity();
- String json = EntityUtils.toString(entity);
- assertTrue(json.contains("\"apiVersion\":\"1.0\""));
- assertTrue(json.contains("\"swaggerVersion\":\"1.2\""));
- assertTrue(json.contains("\"basePath\":\"http://localhost:9001\""));
- assertTrue(json.contains("\"resourcePath\":\"/orders\""));
- request.releaseConnection();
- }
-
- @Test
- public void testApiProductsRoute()
- throws ClientProtocolException, IOException
- {
- HttpGet request = new HttpGet("http://localhost:9001/api-docs/products");
- HttpResponse response = (HttpResponse) http.execute(request);
- HttpEntity entity = response.getEntity();
- String json = EntityUtils.toString(entity);
- assertTrue(json.contains("\"apiVersion\":\"1.0\""));
- assertTrue(json.contains("\"swaggerVersion\":\"1.2\""));
- assertTrue(json.contains("\"basePath\":\"http://localhost:9001\""));
- assertTrue(json.contains("\"resourcePath\":\"/products\""));
- request.releaseConnection();
- }
-
- @Test
- public void testApiHealthRoute()
- throws ClientProtocolException, IOException
- {
- HttpGet request = new HttpGet("http://localhost:9001/api-docs/health");
- HttpResponse response = (HttpResponse) http.execute(request);
- HttpEntity entity = response.getEntity();
- String json = EntityUtils.toString(entity);
- assertTrue(json.contains("\"apiVersion\":\"1.0\""));
- assertTrue(json.contains("\"swaggerVersion\":\"1.2\""));
- assertTrue(json.contains("\"basePath\":\"http://localhost:9001\""));
- assertTrue(json.contains("\"resourcePath\":\"/health\""));
- request.releaseConnection();
- }
-
- @Test
- public void testNickname()
- throws ClientProtocolException, IOException
- {
- HttpGet request = new HttpGet("http://localhost:9001/api-docs/nicknametest");
- HttpResponse response = (HttpResponse) http.execute(request);
- HttpEntity entity = response.getEntity();
- String json = EntityUtils.toString(entity);
- assertTrue(json.contains("\"apiVersion\":\"1.0\""));
- assertTrue(json.contains("\"swaggerVersion\":\"1.2\""));
- assertTrue(json.contains("\"basePath\":\"http://localhost:9001\""));
- assertTrue(json.contains("\"nickname\":\"GETnickNamesh0uld_str1pCHARS\""));
- request.releaseConnection();
- }
-
- @Test
- public void testParametersArrayAlwaysExist()
- throws ClientProtocolException, IOException
- {
- HttpGet request = new HttpGet("http://localhost:9001/api-docs/health");
- HttpResponse response = (HttpResponse) http.execute(request);
- HttpEntity entity = response.getEntity();
- String json = EntityUtils.toString(entity);
- assertTrue(json.contains("\"parameters\":[]"));
- request.releaseConnection();
- }
-
- /**
- * Test controller methods with Swagger annotations return the
- * expected json values.
- */
- @Test
- public void shouldNotShowHiddenApi()
- {
- Response r = get("/api-docs/annotations");
- String json = r.asString();
- assertFalse(json.contains("hidden"));
- }
- /**
- * Test controller methods with Swagger annotations return the
- * expected json values.
- */
- @Test
- public void shouldReturnAnnotationsApi()
- {
- Response r = get("/api-docs/annotations");
- String json = r.asString();
- SwaggerAssert.common(r);
- r.then()
- .body("basePath", equalTo(BASE_URL))
- .body("resourcePath", is("/annotations"));
-
- // For first api verify that summary and notes are populated successfully.
- r.then()
- .root("apis[%s].%s")
- .body(withArgs(0, "path"), is("/annotations/{userId}/users"))
- .body(withArgs(0, "description"), is("Read with Annotations"))
- .body(withArgs(0, "operations"), hasItem(hasEntry("method", "GET")))
- .body(withArgs(0, "operations"), hasItem(hasEntry("type", "Another")))
- .body(withArgs(0, "operations"), hasItem(hasEntry("nickname", "GETReadwithAnnotations")))
- .body(withArgs(0, "operations"), hasItem(hasEntry("summary", "Read with Annotations.")))
- .body(withArgs(0, "operations"), hasItem(hasEntry("notes", "More detailed description here.")));
-
- // For second api verify the three response codes are being returned correctly.
- r.then()
- .root("apis[1].operations[0].responseMessages[%s].%s")
- .body(withArgs(0, "code"), is(204))
- .body(withArgs(0, "message"), is("Successful update"))
- .body(withArgs(1, "code"), is(404))
- .body(withArgs(1, "message"), is("Item not found"))
- .body(withArgs(2, "code"), is(400))
- .body(withArgs(2, "message"), is("Item id incorrect format"));
-
- // For third api verify the parameters are being returned correctly.
- r.then()
- .root("apis[2].operations[0].parameters[%s].%s")
- .body(withArgs(0, "type"), is("string"))
- .body(withArgs(0, "paramType"), is("path"))
- .body(withArgs(0, "name"), is("userId"))
- .body(withArgs(0, "required"), is(true))
- .body(withArgs(1, "type"), is("String"))
- .body(withArgs(1, "description"), is("(Optional) Return item and all its children."))
- .body(withArgs(1, "paramType"), is("query"))
- .body(withArgs(1, "name"), is("expand"))
- .body(withArgs(1, "allowableValues"), is("all, some, none"))
- .body(withArgs(1, "required"), is(false))
- .body(withArgs(2, "type"), is("String"))
- .body(withArgs(2, "description"), is("(Required) Title of the item."))
- .body(withArgs(2, "paramType"), is("body"))
- .body(withArgs(2, "name"), is("title"))
- .body(withArgs(2, "allowableValues"), is("Any string"))
- .body(withArgs(2, "required"), is(true));
-
- // For fourth api verify parameters are being returned correctly.
- r.then()
- .root("apis[3].operations[0].parameters[%s].%s")
- .body(withArgs(0, "type"), is("string"))
- .body(withArgs(0, "paramType"), is("path"))
- .body(withArgs(0, "name"), is("userId"))
- .body(withArgs(0, "required"), is(true))
- .body(withArgs(1, "type"), is("string"))
- .body(withArgs(1, "description"), is("(Required) Title of the item."))
- .body(withArgs(1, "defaultValue"), is("Title placeholder"))
- .body(withArgs(1, "paramType"), is("body"))
- .body(withArgs(1, "name"), is("title"))
- .body(withArgs(1, "allowableValues"), is("Any String"))
- .body(withArgs(1, "required"), is(true));
-
- // Verify the models
- r.then()
- .root("models.%s.properties.%s.%s")
- .body(withArgs("DummyModel", "dummy1", "type"), is("string"))
- .body(withArgs("DummyModel", "dummy2", "type"), is("integer"))
- .body(withArgs("DummyModel", "dummy2", "format"), is("int32"))
- .body(withArgs("DummyModel", "dummy3", "type"), is("number"))
- .body(withArgs("DummyModel", "dummy3", "format"), is("float"))
- .body(withArgs("DummyModel", "dummy4", "type"), is("boolean"))
- .body(withArgs("DummyModel", "dummy5", "type"), is("array"))
- .body(withArgs("DummyModel", "dummy6", "type"), is("array"))
- .body(withArgs("DummyModel", "dummy7", "type"), is("integer"))
- .body(withArgs("DummyModel", "dummy7", "format"), is("int32"))
- .body(withArgs("DummyModel", "dummy8", "type"), is("number"))
- .body(withArgs("DummyModel", "dummy8", "format"), is("double"))
- .body(withArgs("DummyModel", "dummy9", "type"), is("number"))
- .body(withArgs("DummyModel", "dummy10", "type"), is("number"))
- .body(withArgs("DummyModel", "dummy10", "format"), is("double"));
-
- // Make sure that the dummy10 property is not part of the AlternativeDummyModel model
- r.then()
- .root("models.%s.properties.%s")
- .body(withArgs("AlternativeDummyModel", "dummy1"), notNullValue())
- .body(withArgs("AlternativeDummyModel", "dummy2"), notNullValue())
- .body(withArgs("AlternativeDummyModel", "dummy3"), notNullValue())
- .body(withArgs("AlternativeDummyModel", "dummy4"), notNullValue())
- .body(withArgs("AlternativeDummyModel", "dummy5"), notNullValue())
- .body(withArgs("AlternativeDummyModel", "dummy6"), notNullValue())
- .body(withArgs("AlternativeDummyModel", "dummy7"), notNullValue())
- .body(withArgs("AlternativeDummyModel", "dummy8"), notNullValue())
- .body(withArgs("AlternativeDummyModel", "dummy9"), notNullValue())
- .body(withArgs("AlternativeDummyModel", "dummy10"), nullValue());
-
- }
-
-}