programing

Swagger / springfox 자동으로 응답 예제 생성

cafebook 2023. 11. 4. 13:17
반응형

Swagger / springfox 자동으로 응답 예제 생성

현재 springfox 2.9.2를 사용하여 swagger에서 만든 API를 문서화하고 있습니다.이 이미지와 같이 문서에 예제 응답을 추가합니다.

enter image description here

저는 이와 비슷한 일을 할 수 있다고 생각합니다.

@ApiResponses(value = {
    @ApiResponse(code = 200, message = "Success", 
            examples = @io.swagger.annotations.Example(
                value = {
                    @ExampleProperty(value = "{'snapshot'：{'type': 'AAA'}}", mediaType = "application/json") 
                }))

이 코드 조각을 바로 위에 배치합니다.GET이 경우의 방법.불행히도 위의 두 예는 항상 보여집니다: 식별자 예상 오류입니다.

하지만 저도 할 수 있다는 것을 압니다.

@ApiResponses(value = {
    ApiResponse(code = 200, message = "Success", response = MyModel.class,
    )
})

또한 예를 추가할 수 있습니다.@ApiOperation레벨:

@ApiOperation(value = "Create a Account", nickname = "createAccount", notes = "Create a account", response = AccountResponse.class, tags={  })

제 질문은 다음과 같습니다.

  1. 스웨거 설명서에 JSON 응답 예제를 추가하려면 어떻게 해야 합니까?

  2. Swagger/Springfox를 제 모델/bean에 포인트하여 자동으로 예제 응답을 생성하고, bean/model에 대한 각 업데이트로 자동 업데이트하는 것이 이상적입니다.위의 두 번째 코드 조각은 이렇게 해야 합니까?

dto: 주석을 사용하여 예제를 정의합니다.

@ApiModel("Crop")
public class CropDto {

    @ApiModelProperty(name = "Unique guid", position = 1, example = "7aaee0e2-6884-4fd7-ba63-21d76723dce2")
    public UUID id;
    @ApiModelProperty(name = "Unique code", position = 2, example = "squ")
    public String code;
    @ApiModelProperty(name = "Unique name", position = 3, example = "Squash")
    public String name;
    @ApiModelProperty(position = 4, example = "Cucurbita pepo L.")
    public String description;
}

언급URL : https://stackoverflow.com/questions/53617466/swagger-springfox-generating-response-example-automatically

반응형