Skip to content

Commit 0fbf590

Browse files
author
Irena Shaigorodsky
committed
Fixing nested ref in maps
1 parent 1964898 commit 0fbf590

File tree

5 files changed

+288
-4
lines changed

5 files changed

+288
-4
lines changed

‎modules/swagger-codegen/src/main/java/io/swagger/codegen/DefaultCodegen.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1159,8 +1159,9 @@ public String getSwaggerType(Property p) {
11591159
try {
11601160
RefProperty r = (RefProperty) p;
11611161
datatype = r.get$ref();
1162-
if (datatype.indexOf("#/definitions/") == 0) {
1163-
datatype = datatype.substring("#/definitions/".length());
1162+
// '#/definitions' or ../../../../relative-ref/nested/directory/definitions/photos.yml#/definitions/
1163+
if (datatype.indexOf("#/definitions/") >= 0) {
1164+
datatype = datatype.substring(datatype.indexOf("#/definitions/") + "#/definitions/".length());
11641165
}
11651166
} catch (Exception e) {
11661167
LOGGER.warn("Error obtaining the datatype from RefProperty:" + p + ". Datatype default to Object");
@@ -2006,7 +2007,7 @@ protected void setNonArrayMapProperty(CodegenProperty property, String type) {
20062007
/**
20072008
* Override with any special handling of response codes
20082009
* @param responses Swagger Operation's responses
2009-
* @return default method response or <tt>null</tt> if not found
2010+
* @return default method response or &lt;tt&gt;null&lt;/tt&gt; if not found
20102011
*/
20112012
protected Response findMethodResponse(Map<String, Response> responses) {
20122013

‎modules/swagger-codegen/src/test/java/io/swagger/codegen/CodegenTest.java

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,35 @@ public void multiInheritanceOfComposedModelTest() {
366366
Assert.assertEquals(child.parent, "ChildOfComposedParent");
367367
}
368368

369+
@Test(description = "use relative $ref for definitions of parameters")
370+
public void relativeDefinitionsInParameterTest() {
371+
final Swagger model = parseAndPrepareSwagger("src/test/resources/2_0/relative-ref/nested/directory/main/relative-refs.yml");
372+
final DefaultCodegen codegen = new DefaultCodegen();
373+
final String path = "/photo/getPhotos";
374+
final Operation p = model.getPaths().get(path).getPost();
375+
CodegenOperation op = codegen.fromOperation(path, "post", p, model.getDefinitions(), model);
376+
377+
Assert.assertNotNull(op);
378+
Assert.assertNotNull(op.imports);
379+
Assert.assertTrue(op.imports.contains("Photo"));
380+
Assert.assertTrue(op.imports.contains("PhotosRequest"));
381+
382+
}
383+
384+
@Test(description = "use relative $ref for definitions of response")
385+
public void relativeDefinitionsInResponseTest() {
386+
final Swagger model = parseAndPrepareSwagger("src/test/resources/2_0/relative-ref/nested/directory/main/relative-refs.yml");
387+
final DefaultCodegen codegen = new DefaultCodegen();
388+
final String path = "/photo/{id}";
389+
final Operation p = model.getPaths().get(path).getGet();
390+
CodegenOperation op = codegen.fromOperation(path, "get", p, model.getDefinitions(), model);
391+
392+
Assert.assertNotNull(op);
393+
Assert.assertNotNull(op.imports);
394+
Assert.assertTrue(op.imports.contains("Photo"));
395+
Assert.assertTrue(op.imports.contains("integer"));
396+
397+
}
369398

370399
@Test(description = "use operation consumes and produces")
371400
public void localConsumesAndProducesTest() {

‎modules/swagger-codegen/src/test/java/io/swagger/codegen/DefaultGeneratorTest.java

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
package io.swagger.codegen;
22

3+
import com.google.common.collect.ImmutableMap;
4+
import io.swagger.codegen.config.CodegenConfigurator;
35
import io.swagger.codegen.languages.JavaClientCodegen;
46
import io.swagger.models.ExternalDocs;
57
import io.swagger.models.Swagger;
@@ -225,7 +227,54 @@ public void testIssue9132() throws Exception {
225227

226228
}
227229

228-
private boolean containsOverloadedComments(File file, String ...search) throws IOException {
230+
@Test
231+
public void testRelativeRefs() throws IOException {
232+
final File output = folder.getRoot();
233+
234+
CodegenConfigurator codegenConfigurator = new CodegenConfigurator();
235+
codegenConfigurator.setInputSpec("src/test/resources/2_0/relative-ref/nested/directory/main/relative-refs.yml");
236+
codegenConfigurator.setOutputDir(output.getAbsolutePath());
237+
codegenConfigurator.setLang("java");
238+
239+
Map<String, Object> additionalProperties = new HashMap<>();
240+
additionalProperties.put("dateLibrary", "java8");
241+
additionalProperties.put("library", "feign");
242+
additionalProperties.put("apiTests", false);
243+
additionalProperties.put("hideGenerationTimestamp", true);
244+
additionalProperties.put("invokerPackage", "com.mycompany.generated.client");
245+
additionalProperties.put("modelPackage", "com.mycompany.generated.client.model");
246+
additionalProperties.put("apiPackage", "com.mycompany.generated.client.api");
247+
248+
codegenConfigurator.setAdditionalProperties(additionalProperties);
249+
250+
Map<String, String> importMapping = new HashMap<>();
251+
252+
importMapping.put("LocalDateTime", "java.time.LocalDateTime");
253+
importMapping.put("LocalTime", "java.time.LocalTime");
254+
importMapping.put("DayOfWeek", "java.time.DayOfWeek");
255+
importMapping.put("Duration", "java.time.Duration");
256+
importMapping.put("ChronoUnit", "java.time.temporal.ChronoUnit");
257+
importMapping.put("Currency", "java.util.Currency");
258+
importMapping.put("LocalDate", "java.time.LocalDate");
259+
importMapping.put("Locale", "java.util.Locale");
260+
importMapping.put("ZoneId", "java.time.ZoneId");
261+
262+
codegenConfigurator.setImportMappings(importMapping);
263+
264+
DefaultGenerator generator = new DefaultGenerator();
265+
generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_TESTS, "false");
266+
generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_DOCS, "false");
267+
generator.setGeneratorPropertyDefault(CodegenConstants.API_TESTS, "false");
268+
generator.setGeneratorPropertyDefault(CodegenConstants.API_DOCS, "false");
269+
270+
//generate
271+
generator.opts(codegenConfigurator.toClientOptInput()).generate();
272+
final File defaultApi = new File(output, "src/main/java/com/mycompany/generated/client/api/DefaultApi.java");
273+
assertTrue(defaultApi.exists());
274+
assertFalse(containsSearchStrings(defaultApi,"RelativeRefnesteddirectorydefinitionsphotosYmldefinitionsPhoto"));
275+
}
276+
277+
private boolean containsSearchStrings(File file, String ...search) throws IOException {
229278
for (String line : Files.readAllLines(file.toPath(), Charset.defaultCharset())) {
230279
if (StringUtils.containsAny(line, search)) {
231280
return true;
@@ -235,6 +284,10 @@ private boolean containsOverloadedComments(File file, String ...search) throws I
235284
return false;
236285
}
237286

287+
private boolean containsOverloadedComments(File file, String ...search) throws IOException {
288+
return containsSearchStrings(file, search);
289+
}
290+
238291
@Test
239292
public void testOverloadingTemplateFiles() throws Exception {
240293
final File output = folder.getRoot();

‎modules/swagger-codegen/src/test/resources/2_0/relative-ref/nested/directory/definitions/photos.yml

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
swagger: '2.0'
2+
info:
3+
title: Photos API
4+
description: Photo service
5+
6+
schemes:
7+
- http
8+
9+
produces:
10+
- application/json
11+
12+
# prefix for all paths
13+
# for breaking changes, we need to change the basePath and add a second swagger file
14+
basePath: /v1
15+
16+
paths:
17+
/photo/photos:
18+
post:
19+
operationId: getPhotos
20+
description: Retrieve photos by ids
21+
parameters:
22+
- name: photosRequest
23+
in: body
24+
required: true
25+
description: The photos being requested
26+
schema:
27+
$ref: '#/definitions/PhotosRequest'
28+
responses:
29+
200:
30+
description: A collection of Photos
31+
schema:
32+
type: array
33+
items:
34+
$ref: '#/definitions/Photo'
35+
36+
definitions:
37+
Photo:
38+
properties:
39+
id:
40+
type: integer
41+
format: int32
42+
description: The photo id (always present in the response)
43+
caption:
44+
type: string
45+
description: |
46+
Caption to be shown for the photo in the UI.
47+
uploadDate:
48+
type: string
49+
format: date
50+
description: The upload date for the image (requested using PhotoField.UPLOAD_DATE)
51+
uploadDateTime:
52+
type: string
53+
format: date-time
54+
description: The upload date-time (in UTC) for the image (requested using PhotoField.UPLOAD_DATETIME)
55+
56+
PhotosRequest:
57+
required:
58+
- photoIds
59+
- photoFields
60+
properties:
61+
photoIds:
62+
type: array
63+
items:
64+
type: integer
65+
format: int32
66+
photoFields:
67+
description: |
68+
The fields of a photo object to be retrieved.
69+
If none are specified, only the id comes back
70+
type: array
71+
items:
72+
$ref: '#/definitions/PhotoField'
73+
74+
PhotoField:
75+
type: string
76+
enum:
77+
- CAPTION
78+
- UPLOAD_DATE
79+
- UPLOAD_DATETIME
80+
81+
PhotoThumbnailsRequest:
82+
required:
83+
- ids
84+
- photoFields
85+
properties:
86+
ids:
87+
type: array
88+
items:
89+
type: integer
90+
format: int32
91+
photoFields:
92+
description: |
93+
The fields of a photo object to be retrieved.
94+
If none are specified, only the id comes back
95+
type: array
96+
items:
97+
$ref: '#/definitions/PhotoField'

‎modules/swagger-codegen/src/test/resources/2_0/relative-ref/nested/directory/main/relative-refs.yml

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
swagger: '2.0'
2+
info:
3+
title: API Definition with Relative models
4+
description: This is an example
5+
schemes:
6+
- https
7+
- http
8+
9+
produces:
10+
- application/json
11+
12+
basePath: /v1
13+
14+
paths:
15+
/photo/getPhotos:
16+
post:
17+
operationId: getPhotos
18+
description: Retrieve photos by ids
19+
parameters:
20+
- name: photosRequest
21+
in: body
22+
required: true
23+
description: The photos being requested
24+
schema:
25+
$ref: '../../../../relative-ref/nested/directory/definitions/photos.yml#/definitions/PhotosRequest'
26+
responses:
27+
200:
28+
description: A collection of Photos
29+
schema:
30+
type: array
31+
items:
32+
$ref: '../../../../relative-ref/nested/directory/definitions/photos.yml#/definitions/Photo'
33+
34+
/photo/{id}:
35+
get:
36+
operationId: get photo by Id
37+
description: Retrieve photo by id
38+
parameters:
39+
- name: "id"
40+
in: "path"
41+
description: "id"
42+
required: true
43+
type: integer
44+
format: int32
45+
responses:
46+
200:
47+
description: A collection of Photos
48+
schema:
49+
type: array
50+
items:
51+
$ref: '../../../../relative-ref/nested/directory/definitions/photos.yml#/definitions/Photo'
52+
53+
/photo/getPhotoPreview/{id}:
54+
post:
55+
operationId: getPhotoPreview
56+
description: get thumbnail preview of a photo
57+
parameters:
58+
- name: id
59+
in: path
60+
type: integer
61+
minimum: 1
62+
required: true
63+
description: the id of photo thumbnail requested
64+
responses:
65+
200:
66+
description: the response containing a preview thumbnail, along with some additional information about the photo
67+
schema:
68+
$ref: '#/definitions/PhotoPreview'
69+
70+
/photo/thumbnails:
71+
post:
72+
operationId: getThumbnails
73+
description: Retrieve photo thumbnails by ids
74+
parameters:
75+
- name: photoThumbnailsRequest
76+
in: body
77+
required: true
78+
description: The photos being requested
79+
schema:
80+
$ref: '../../../../relative-ref/nested/directory/definitions/photos.yml#/definitions/PhotoThumbnailsRequest'
81+
responses:
82+
200:
83+
description: |
84+
A map of id -> photo for requested ids.
85+
schema:
86+
type: object
87+
additionalProperties:
88+
$ref: '../../../../relative-ref/nested/directory/definitions/photos.yml#/definitions/Photo'
89+
90+
definitions:
91+
PhotoPreview:
92+
type: object
93+
properties:
94+
id:
95+
description: the id of the newly inserted photo
96+
type: integer
97+
format: int32
98+
caption:
99+
description: the caption of the photo
100+
type: string
101+
thumbnail:
102+
description: The media binary of thumbnail
103+
type: string
104+
format: byte

0 commit comments

Comments
 (0)