Swagger - 예제 요청 본문을 사용자 정의하십시오.

Question

POST 작업을위한 스프링 MVC 엔드 포인트가 있습니다. 이 작업은 경로 매개 변수와 (json) 요청 엔터티를 사용합니다. Swagger UI가 생성되면 자동으로 요청 본문 데이터 유형의 예제 값을 만듭니다. 이 예제는 애플리케이션의 자바 엔티티를 기반으로합니다. 엔티티는 일부 다른 작업에 사용되지만 POST 작업의 경우이 예제에 노출 된 엔티티 필드 중 일부는 원하지 않습니다. 기존 자바 모델을 수정하지 않고이 예제를 수정할 수 있습니까? 예를 들어, 아래 예제에서 제외 할 수 있습니까 lastUpdate.

Answer 1

예는 잭슨 JsonIgnore 주석을 사용하여 실시 예 lastUpdate 값을 무시하는 것이 가능하다.

import com.fasterxml.jackson.annotation.JsonIgnore;  

public class Phone { 
    private String phoneNumber; 
    private String lastUpdate; 
    private int status; 

    public String getPhoneNumber() { 
    return phoneNumber; 
    } 
    public void setPhoneNumber(String phoneNumber) { 
    this.phoneNumber = phoneNumber; 
    } 

    @JsonIgnore 
    public String getLastUpdate() { 
    return lastUpdate; 
    } 
    public void setLastUpdate() { 
    this.lastUpdate = lastUpdate; 
    } 

    public int getStatus() { 
    return lastUpdate; 
    } 
    public void setStatus() { 
    this.status = status; 
    } 
}