Merge pull request #1145 from swagger-api/encoding-issue

Fix for encoding issue #1119

Author: gracekarina

modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/OpenAPIV3Parser.java

@@ -18,6 +18,7 @@
 import org.slf4j.LoggerFactory;
 
 import java.net.URI;
+import java.nio.charset.Charset;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -30,11 +31,23 @@
 public class OpenAPIV3Parser implements SwaggerParserExtension {
     private static ObjectMapper JSON_MAPPER, YAML_MAPPER;
     private static final Logger LOGGER = LoggerFactory.getLogger(OpenAPIV3Parser.class);
+    private static String encoding = "UTF-8";
 
     static {
         JSON_MAPPER = ObjectMapperFactory.createJson();
         YAML_MAPPER = ObjectMapperFactory.createYaml();
     }
+
+    public static String getEncoding() {
+        return encoding;
+    }
+
+    public static void setEncoding(String encoding) {
+        if (Charset.isSupported(encoding)) {
+            OpenAPIV3Parser.encoding = encoding;
+        }
+    }
+
     @Override
     public SwaggerParseResult readLocation(String url, List<AuthorizationValue> auth, ParseOptions options) {
         SwaggerParseResult result = new SwaggerParseResult();
@@ -130,7 +143,7 @@ public SwaggerParseResult readWithInfo(String location, List<AuthorizationValue>
                     path = Paths.get(location);
                 }
                 if (Files.exists(path)) {
-                    data = FileUtils.readFileToString(path.toFile(), "UTF-8");
+                    data = FileUtils.readFileToString(path.toFile(), encoding);
                 } else {
                     data = ClasspathHelper.loadFileFromClasspath(location);
                 }

modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OpenAPIV3ParserTest.java

@@ -67,6 +67,29 @@ public class OpenAPIV3ParserTest {
     protected WireMockServer wireMockServer;
 
 
+
+    @Test
+    public void testIssue339() throws Exception {
+        OpenAPIV3Parser openAPIV3Parser = new OpenAPIV3Parser();
+        OpenAPI api = openAPIV3Parser.read("issue-339.yaml");
+        assertNotNull(api);
+        Parameter param = api.getPaths().get("/store/order/{orderId}").getGet().getParameters().get(0);
+        assertTrue(param instanceof PathParameter);
+        PathParameter pp = (PathParameter) param;
+        assertTrue(pp.getSchema().getMinimum().toString().equals("1"));
+        assertTrue(pp.getSchema().getMaximum().toString().equals("5"));
+    }
+
+    @Test
+    public void testIssue1119() {
+        OpenAPIV3Parser parser = new OpenAPIV3Parser();
+        parser.setEncoding("ISO-8859-1");
+        OpenAPI openAPI = parser.read("src/test/resources/issue-1119.yaml");
+        assertNotNull(openAPI);
+        assertEquals(openAPI.getPaths().get("/pets").getGet().getParameters().get(0).getDescription(),"Cuántos artículos devolver al mismo tiempo (máximo 100)");
+    }
+
+
     @Test
     public void testIssue1108() {
         OpenAPIV3Parser parser = new OpenAPIV3Parser();
@@ -1337,19 +1360,6 @@ public void testCodegenPetstore() {
         assertEquals(minimum.toString(), "1");
     }
 
-    @Test
-    public void testIssue339() throws Exception {
-        OpenAPIV3Parser parser = new OpenAPIV3Parser();
-        final OpenAPI openAPI = parser.read("src/test/resources/issue-339.yaml");
-
-        Parameter param = openAPI.getPaths().get("/store/order/{orderId}").getGet().getParameters().get(0);
-        assertTrue(param instanceof PathParameter);
-        PathParameter pp = (PathParameter) param;
-
-        assertTrue(pp.getSchema().getMinimum().toString().equals("1"));
-        assertTrue(pp.getSchema().getMaximum().toString().equals("5"));
-    }
-
     @Test
     public void testCodegenIssue4555() throws Exception {
         OpenAPIV3Parser parser = new OpenAPIV3Parser();

modules/swagger-parser-v3/src/test/resources/issue-1119.yaml

@@ -0,0 +1,109 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+  - url: http://petstore.swagger.io/v1
+paths:
+  /pets:
+    get:
+      summary: Listado de todas las 
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: Cuántos artículos devolver al mismo tiempo (máximo 100)
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: Una colección paginada de mascotas
+          headers:
+            x-next:
+              description: Un enlace a la siguiente página de respuestas.
+              schema:
+                type: string
+          content:
+            application/json:    
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: Error inesperado
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      responses:
+        '201':
+          description: respuesta Null
+        default:
+          description: Error inesperado
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /pets/{petId}:
+    get:
+      summary: Información para una mascota específica
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: El id de la mascota a recuperar.
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Respuesta esperada a una solicitud válida
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: error inesperado
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Pets:
+      type: array
+      items:
+        $ref: "#/components/schemas/Pet"
+    Error:
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string