Swagger-core: Spring 프로젝트에 ModelConverter를 추가하는 방법은 무엇입니까?

에 만든 2015년 10월 29일 · 4코멘트 · 출처: swagger-api/swagger-core

Spring MVC 및 Spring 부트가 있는 프로젝트가 있습니다.
내 json 서비스를 문서화하기 위해 Swagger springfox를 사용합니다. java.sql.Time 및 java.util.Date 속성이 있는 클래스가 있습니다.
API를 호출하면 클래스가 다음과 같이 나타납니다.

"TranslationLabel":{
    "properties":{
        "change_date":{
            "type":"string",
            "format":"date-time"
        },
        "change_time":{
            "$ref":"#/definitions/Time"
        }
    },
    "description":"Traduction de libellé"
}

Swagger UI에서 모델 스키마는 다음과 같습니다.

 {
  "change_date": "2015-10-29",
  "change_time": {
    "date": 0,
    "day": 0,
    "hours": 0,
    "minutes": 0,
    "month": 0,
    "seconds": 0,
    "time": 0,
    "timezoneOffset": 0,
    "year": 0
  }
}

"15:31"과 같이 "change_time"을 표시하고 싶습니다.
이렇게 하려면 ModelConverter를 사용해야 한다고 생각합니다. 그래서 이 예제를 기반으로 사용자 지정 변환기 클래스를 만듭니다. https://github.com/swagger-api/swagger-core/blob/master/modules/swagger-core/src/test/java/io/swagger/model/ 재정의/CustomConverterTest.java
그러나 나는 그것을 사용하는 방법을 찾지 못했습니다.

여기 내 수업이 있습니다 :

class CustomConverter implements ModelConverter {
    <strong i="18">@Override</strong>
    public Property resolveProperty(Type type, ModelConverterContext context, Annotation[] annotations,
                                    Iterator<ModelConverter> chain) {
        final JavaType jType = Json.mapper().constructType(type);
        if (jType != null) {
            final Class<?> cls = jType.getRawClass();
            if (cls.equals(Time.class)) {
                HashMap<PropertyBuilder.PropertyId, Object> map =
                        new HashMap<>();
                map.put(PropertyBuilder.PropertyId.FORMAT,"HH:mm");
                map.put(PropertyBuilder.PropertyId.TYPE,"time");
                map.put(PropertyBuilder.PropertyId.EXAMPLE,"12:30");
                return PropertyBuilder.build("Time", "hh:mm", map);
            } else {
                return chain.next().resolveProperty(type, context, annotations, chain);
            }
        } else {
            return null;
        }
    }

    <strong i="19">@Override</strong>
    public Model resolve(Type type, ModelConverterContext context, Iterator<ModelConverter> chain) {
        return chain.next().resolve(type, context, chain);
    }
}

이제 ModelConverters에 변환기를 추가해야 합니다.

ModelConverters converters = new ModelConverters();
converters.addConverter(new CustomConverter());

이 코드를 어디에 넣어야 하는지에 대한 문서를 찾지 못했습니다.
이걸 어디에 넣어야 했어?

Support

출처

YLombardi

가장 유용한 댓글

Springfox 에는 이를 달성하는 다른 방법이 있습니다. 동등한 변환기를 정의하려면 Docket.directmodelSubstitute(Time.class, String.class) 를 사용해야 합니다. 그러나 예제 등은 지원하지 않습니다.

dilipkrish 에 2015년 10월 29일

👍2 🎉1

모든 4 댓글

dilipkrish 에 2015년 10월 29일

👍2 🎉1

답변해 주셔서 감사합니다.
귀하의 솔루션을 시도했지만 "change_time":"hh:mm" 대신 "change_time":"string"을 표시합니다.
String 의 형식을 지정할 수 있습니까?

YLombardi 에 2015년 10월 29일

안녕하세요 여러분,

ModelConverters와 관련된 문제가 있습니다. 내 Swagger.json에는 아래와 같이 확장된 형식의 일반 클래스가 포함되어 있습니다.

"JsonNode": {
"유형": "객체",
"속성": {
"floatingPointNumber": {
"유형": "부울",
"기본값": 거짓
},
"값 노드": {
"유형": "부울",
"기본값": 거짓
},
"bigInteger": {
"유형": "부울",
"기본값": 거짓
},
"텍스트": {
"유형": "부울",
"기본값": 거짓
},
"부울": {
"유형": "부울",
"기본값": 거짓
},
"컨테이너 노드": {
"유형": "부울",
"기본값": 거짓
},
"missingNode": {
"유형": "부울",
"기본값": 거짓
},
"물체": {
"유형": "부울",
"기본값": 거짓
},
"포조": {
"유형": "부울",
"기본값": 거짓
},
"숫자": {
"유형": "부울",
"기본값": 거짓
},
"integralNumber": {
"유형": "부울",
"기본값": 거짓
},
"짧은": {
"유형": "부울",
"기본값": 거짓
},
"int": {
"유형": "부울",
"기본값": 거짓
},
"긴": {
"유형": "부울",
"기본값": 거짓
},
"더블": {
"유형": "부울",
"기본값": 거짓
},
"bigDecimal": {
"유형": "부울",
"기본값": 거짓
},
"뜨다": {
"유형": "부울",
"기본값": 거짓
},
"노드 유형": {
"유형": "문자열",
"열거": [
"정렬",
"바이너리",
"부울",
"잃어버린",
"없는",
"숫자",
"물체",
"포조",
"끈"
]
},
"바이너리": {
"유형": "부울",
"기본값": 거짓
},
"배열": {
"유형": "부울",
"기본값": 거짓
},
"없는": {
"유형": "부울",
"기본값": 거짓
}
}
}

이제 이것은 확실히 내가 원하지 않는 것입니다. 사실 내가 원하는 것은 이 특정 클래스(com.fasterxml.jackson.databind.JsonNode)(및 내가 선택한 다른 클래스)가 확장되는 것을 방지하는 것입니다. 그래서 이를 수행하기 위해 아래에 표시된 io.swagger.converter.ModelConverters 클래스에서 제공되는 내장 함수를 사용했습니다.

공개 무효 addClassToSkip(문자열 cls) {
LOGGER.warn("클래스 건너뛰기 " + cls);
this.skippedClasses.add(cls);
}

이제 이 작업을 수행한 후 ModelConverters 클래스를 다른 사람과 함께 공급자 목록에 추가하려고 시도했지만 결과가 없었기 때문에 실제로 ModelConverters 클래스를 주입할 위치를 알아낼 수 없는 것 같습니다. 누군가 이 문제를 도와주세요. 나는 거의 3 일 동안 답을 찾고있었습니다.

sagar-suri 에 2017년 05월 24일

사용자 정의 변환기를 사용하십시오. 이것은 내 분석에 따른 버그입니다. ModelResolver를 자신의 코드에 복사하고 이와 같은 작업을 수행할 수 있습니다.

ModelConverters.getInstance().addConverter(new ModelResolver(mapper));

ModelResolver에서 다음 해결 방법을 수정합니다.

private Model resolve(JavaType type, ModelConverterContext context, Iterator<ModelConverter> next) {
        if (type.isEnumType() || PrimitiveType.fromType(type) != null) {
            // We don't build models for primitive types
            return null;
        }

        if (type instanceof SimpleType && ((SimpleType) type).getRawClass().getName().startsWith("your classname")) {
            return yourConverter.resolve(type, context, next);
        }

해킹입니다. 문제는 https://github.com/swagger-api/swagger-core/issues/2260 과 동일합니다.

ssoffline 에 2017년 06월 20일

이 페이지가 도움이 되었나요?

0 / 5 - 0 등급

Swagger-core: Spring 프로젝트에 ModelConverter를 추가하는 방법은 무엇입니까?

가장 유용한 댓글

모든 4 댓글

관련 문제