urbug2
1k
2018-11-09 17:55:58 작성 2018-11-09 17:59:49 수정됨
2
112

swagger 에서 모델로 파라미터를 받을 때, description을 메서드마다 다르게 설정할 수 있는 방법이 있을까요?


만약 컨트롤러에서.

	@PostMapping("/sample")
	public Sample insert(@RequestBody(required=true ) Sample sample) {
		return sampleService.insert(sample);
	}

	@PutMapping("/sample")
	public void update(@RequestBody(required = true) Sample sample) {
		sampleService.update(sample);
	}


이런 식으로 값을 받을 경우, Sample의 식별자는 각 메서드에 따라 필수여부가 달라지게 되는데요.
이런 것을 각각 다른게 description할 수 있는 방법이 있을까요?
이런 설정이 지금은 model안에 있게 되어,
설정정보가 endpoint에 종속적이지 않고, 모델에 종속적이게 되어서 문제가 있네요.


일반적인 파라미터는 @ApiImplicitParam 으로 endpoint에 종속적인데..
왜 vo로 받을 경우에 대해서는 vo에 종속적으로 될 수 밖에 없는 것인지...
(이런 것은 아주 보편적으로 겪게 되는 상황인데... 정확하게 해당내용을 명시한 url을 못찾겠어요.)


혹시 방법을 아시는 분의 도움을 구합니다.

0
0
  • 답변 2

  • bangbang
    304
    2018-11-09 18:04:56

    https://github.com/swagger-api/swagger-core/wiki/annotations#apioperation


    요렇게 해보세요

    0
  • urbug2
    1k
    2018-11-12 09:40:15 작성 2018-11-12 09:41:45 수정됨

    답변 감사합니다.

    그런데 제가 response을 어떻게 할 것인가보다는.
    같은 모델(vo)을 request할 경우 메서드마다 주석을 어떻게 다르게 기술할 수 있는가? 이거든요..
    이 부분은 검색을 해도 쓸만한 답변이 도통 없네요..


    0
  • 로그인을 하시면 답변을 등록할 수 있습니다.