|
| 1 | +package io.swagger; |
| 2 | + |
| 3 | +import static org.testng.Assert.assertEquals; |
| 4 | +import static org.testng.Assert.assertNotNull; |
| 5 | + |
| 6 | +import io.swagger.jaxrs.Reader; |
| 7 | +import io.swagger.models.ModelImpl; |
| 8 | +import io.swagger.models.Operation; |
| 9 | +import io.swagger.models.Swagger; |
| 10 | +import io.swagger.models.parameters.BodyParameter; |
| 11 | +import io.swagger.models.parameters.HeaderParameter; |
| 12 | +import io.swagger.models.parameters.Parameter; |
| 13 | +import io.swagger.models.parameters.QueryParameter; |
| 14 | +import io.swagger.resources.ResourceWithBeanParams; |
| 15 | +import io.swagger.resources.ResourceWithComplexBodyInputType; |
| 16 | +import io.swagger.util.Json; |
| 17 | + |
| 18 | +import org.testng.annotations.Test; |
| 19 | + |
| 20 | +import java.util.List; |
| 21 | + |
| 22 | +public class ScannerTest { |
| 23 | + |
| 24 | + @Test(description = "scan a simple resource") |
| 25 | + public void scanSimpleResource() { |
| 26 | + final Swagger swagger = getSwagger(ResourceWithBeanParams.class); |
| 27 | + final List<Parameter> params = getParameters(swagger, "/{id}"); |
| 28 | + |
| 29 | + final Parameter skip = params.get(0); |
| 30 | + assertEquals(skip.getName(), "skip"); |
| 31 | + assertEquals(skip.getDescription(), "number of records to skip"); |
| 32 | + |
| 33 | + final Parameter limit = params.get(1); |
| 34 | + assertEquals(limit.getName(), "limit"); |
| 35 | + assertEquals(limit.getDescription(), "maximum number of records to return"); |
| 36 | + } |
| 37 | + |
| 38 | + @Test(description = "scan another resource") |
| 39 | + public void scanAnotherResource() { |
| 40 | + final Swagger swagger = getSwagger(ResourceWithComplexBodyInputType.class); |
| 41 | + |
| 42 | + final Operation post = swagger.getPaths().get("/myapi/testPostWithBody").getPost(); |
| 43 | + assertNotNull(post); |
| 44 | + |
| 45 | + assertNotNull(swagger.getDefinitions()); |
| 46 | + assertNotNull(swagger.getDefinitions().get("ClassWithString")); |
| 47 | + } |
| 48 | + |
| 49 | + @Test(description = "scan a bean param resource") |
| 50 | + public void scanBeanParamResource() { |
| 51 | + final Swagger swagger = getSwagger(ResourceWithBeanParams.class); |
| 52 | + final List<Parameter> params = getParameters(swagger, "/bean/{id}"); |
| 53 | + |
| 54 | + final HeaderParameter headerParam1 = (HeaderParameter) params.get(0); |
| 55 | + assertEquals(headerParam1.getDefaultValue(), "1"); |
| 56 | + assertEquals(headerParam1.getName(), "test order annotation 1"); |
| 57 | + |
| 58 | + final HeaderParameter headerParam2 = (HeaderParameter) params.get(1); |
| 59 | + assertEquals(headerParam2.getDefaultValue(), "2"); |
| 60 | + assertEquals(headerParam2.getName(), "test order annotation 2"); |
| 61 | + |
| 62 | + final QueryParameter priority1 = (QueryParameter) params.get(2); |
| 63 | + assertEquals(priority1.getDefaultValue(), "overridden"); |
| 64 | + assertEquals(priority1.getName(), "test priority 1"); |
| 65 | + |
| 66 | + final QueryParameter priority2 = (QueryParameter) params.get(3); |
| 67 | + assertEquals(priority2.getDefaultValue(), "overridden"); |
| 68 | + assertEquals(priority2.getName(), "test priority 2"); |
| 69 | + |
| 70 | + final ModelImpl bodyParam1 = (ModelImpl) ((BodyParameter) params.get(4)).getSchema(); |
| 71 | + assertEquals(bodyParam1.getDefaultValue(), "bodyParam"); |
| 72 | + } |
| 73 | + |
| 74 | + private List<Parameter> getParameters(Swagger swagger, String path) { |
| 75 | + return swagger.getPaths().get(path).getGet().getParameters(); |
| 76 | + } |
| 77 | + |
| 78 | + private Swagger getSwagger(Class<?> clas) { |
| 79 | + return new Reader(new Swagger()).read(clas); |
| 80 | + } |
| 81 | +} |
0 commit comments