JsonViewTest.java

package io.swagger.v3.jaxrs2;

import io.swagger.v3.core.util.Json;
import io.swagger.v3.core.util.Yaml;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.PathItem;
import io.swagger.v3.oas.models.media.MediaType;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonView;
import com.fasterxml.jackson.core.JsonProcessingException;

import java.util.Arrays;
import java.util.List;
import java.util.Set;

import javax.ws.rs.GET;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.core.Response;

import org.testng.annotations.Test;

import static org.testng.Assert.assertFalse;
import static org.testng.Assert.assertTrue;

public class JsonViewTest {

    private static class View {

        interface Summary {

        }

        interface Detail extends Summary {

        }

        interface Sale {

        }
    }

    private static class Car {

        @JsonView(View.Summary.class)
        @JsonProperty("manufacture")
        private String made = "Honda";

        @JsonView({View.Summary.class, View.Detail.class})
        private String model = "Accord Hybrid";

        @JsonView({View.Detail.class})
        @JsonProperty
        private List<Tire> tires = Arrays.asList(new Tire());

        @JsonView({View.Sale.class})
        @JsonProperty
        private int price = 40000;

        // always in
        private String color = "White";

        public String getColor() {
            return color;
        }
    }

    private static class Tire {

        @JsonView(View.Summary.class)
        @JsonProperty("brand")
        private String made = "Michelin";

        @JsonView(View.Detail.class)
        @JsonProperty
        private String condition = "new";
    }

    @Path("/")
    private static class CarSummaryApi {

        @GET
        @Path("/cars/summary")
        @JsonView({View.Summary.class})
        public List<Car> getSummaries() {
            return Arrays.asList(new Car());
        }
    }

    @Path("/")
    private static class CarSummaryUpdateApi {

        @PUT
        @Path("/cars/summary")
        @Operation(description = "Updates a car summary.")
        public Response updateCarSummary(
            @RequestBody(content = @Content(schema = @Schema(implementation = Car.class)))
            @JsonView(View.Summary.class)
            Car car) {

            return Response.noContent()
                .build();
        }
    }

    @Path("/")
    private static class CarDetailApi {

        @GET
        @Path("/cars/detail")
        @JsonView({View.Detail.class})
        @Operation(description = "Return car detail",
                responses = @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema (implementation = Car.class)))))
        public Response getDetails() {
            return Response.ok(Arrays.asList(new Car())).build();
        }
    }

    @Path("/")
    private static class CarSaleSummaryApi {

        @GET
        @Path("/cars/sale")
        @JsonView({View.Summary.class, View.Sale.class})
        public List<Car> getSaleSummaries() {
            return Arrays.asList(new Car());
        }
    }

    @Path("/")
    private static class CarApi {

        @GET
        @Path("/cars")
        public List<Car> getCars() {
            return Arrays.asList(new Car());
        }
    }

    @Path("/ignore")
    private static class CarIgnoreApi {

        @GET
        @Path("/cars")
        @JsonView({View.Summary.class, View.Sale.class})
        @Operation(ignoreJsonView = true)
        public List<Car> getCars() {
            return Arrays.asList(new Car());
        }
    }

    @Test(description = "check awareness of JsonView")
    public void shouldSerializeTypeParameter() throws JsonProcessingException {

        Reader reader = new Reader(new OpenAPI());

        OpenAPI openAPI = reader.read(CarSummaryApi.class);
        String openApiJson = Json.mapper().writeValueAsString(openAPI);
        assertTrue(openApiJson.contains("manufacture"));
        assertTrue(openApiJson.contains("model"));
        assertTrue(openApiJson.contains("color"));
        assertFalse(openApiJson.contains("tires"));
        assertFalse(openApiJson.contains("made"));
        assertFalse(openApiJson.contains("condition"));

        reader = new Reader(new OpenAPI());
        openAPI = reader.read(CarSummaryUpdateApi.class);
        Set carSummarySchemaProperties = openAPI.getComponents()
            .getSchemas()
            .get("Car_Summary")
            .getProperties()
            .keySet();
        String carSummaryUpdateApiRequestBodySchemaRef = openAPI.getPaths()
            .values()
            .stream()
            .findAny()
            .orElse(new PathItem())
            .getPut()
            .getRequestBody()
            .getContent()
            .values()
            .stream()
            .findAny()
            .orElse(new MediaType())
            .getSchema()
            .get$ref();
        assertTrue(carSummarySchemaProperties.contains("manufacture"));
        assertTrue(carSummarySchemaProperties.contains("model"));
        assertTrue(carSummarySchemaProperties.contains("color"));
        assertFalse(carSummarySchemaProperties.contains("price"));
        assertFalse(carSummarySchemaProperties.contains("tires"));
        assertFalse(carSummarySchemaProperties.contains("made"));
        assertFalse(carSummarySchemaProperties.contains("condition"));
        assertTrue(carSummaryUpdateApiRequestBodySchemaRef.contains("Car_Summary"));

        reader = new Reader(new OpenAPI());
        openAPI = reader.read(CarDetailApi.class);
        openApiJson = Json.mapper().writeValueAsString(openAPI);
        assertTrue(openApiJson.contains("manufacture"));
        assertTrue(openApiJson.contains("model"));
        assertTrue(openApiJson.contains("color"));
        assertTrue(openApiJson.contains("tires"));
        assertTrue(openApiJson.contains("brand"));
        assertTrue(openApiJson.contains("condition"));
        assertTrue(openApiJson.contains("Car_Detail"));

        reader = new Reader(new OpenAPI());
        openAPI = reader.read(CarSaleSummaryApi.class);
        openApiJson = Json.mapper().writeValueAsString(openAPI);
        Yaml.prettyPrint(openAPI);
        assertTrue(openApiJson.contains("manufacture"));
        assertTrue(openApiJson.contains("model"));
        assertTrue(openApiJson.contains("color"));
        assertTrue(openApiJson.contains("price"));
        assertFalse(openApiJson.contains("tires"));
        assertFalse(openApiJson.contains("made"));
        assertFalse(openApiJson.contains("condition"));

        reader = new Reader(new OpenAPI());
        openAPI = reader.read(CarApi.class);
        openApiJson = Json.mapper().writeValueAsString(openAPI);
        assertTrue(openApiJson.contains("manufacture"));
        assertTrue(openApiJson.contains("model"));
        assertTrue(openApiJson.contains("color"));
        assertTrue(openApiJson.contains("price"));
        assertTrue(openApiJson.contains("tires"));
        assertFalse(openApiJson.contains("made"));
        assertTrue(openApiJson.contains("condition"));

        reader = new Reader(new OpenAPI());
        openAPI = reader.read(CarIgnoreApi.class);
        openApiJson = Json.mapper().writeValueAsString(openAPI);
        assertTrue(openApiJson.contains("manufacture"));
        assertTrue(openApiJson.contains("model"));
        assertTrue(openApiJson.contains("color"));
        assertTrue(openApiJson.contains("price"));
        assertTrue(openApiJson.contains("tires"));
        assertFalse(openApiJson.contains("made"));
        assertTrue(openApiJson.contains("condition"));
    }

}