This repository has been archived by the owner on Sep 16, 2024. It is now read-only.
[Feat] Swagger 적용 #41
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
[카톡대화]
추가 제안
|
|
goldentrash
commented
Jan 25, 2024
| @@ -29,6 +29,7 @@ data class CompanionPlantCreateRequest( | |||
| waterCycle = waterCycle, | |||
| birthDate = this.birthDate, | |||
| memberId = memberId, | |||
| plantInformationId = plantInformationId | |||
There was a problem hiding this comment.
TEST는 어째서 통과...? 어렵다 JPA....
zbqmgldjfh
approved these changes
Jan 25, 2024
| @@ -24,44 +27,57 @@ class PlantCommandApi( | |||
| private val plantService: PlantService, | |||
| ) { | |||
|
|
|||
| @Operation(summary = "반려식물 등록", description = "사용자의 반려식물을 등록/추가합니다.") | |||
| @ApiResponse(responseCode = "200", description = "등록 성공") | |||
There was a problem hiding this comment.
@securityrequirement(name = "Device-Token") 추가해주시면 감사하겠습니다!!
다른 부분도 토큰이 필요한 곳에 추가해주시면 좋을것 같아요!!
| import org.springframework.web.bind.annotation.RestController | ||
| import java.time.LocalDate | ||
| import java.time.YearMonth | ||
|
|
||
| @RestController | ||
| @RequestMapping("/api/v1/plants") |
There was a problem hiding this comment.
어떤일을 할지 다음과 같이 API 상단에도 추가해주면 클라이언트가 더 이해하기 수월할것 같아요!! @tag(name = "Plant-Query", description = "식물 정보 조회")
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
개요
Swagger 적용 ( close #35 )
Todo
@AccessDeviceToken에@Parameter를 통한 정보 추가논의가 필요한 사항
openAPI v3 spec에 따라 GET에는 request body를 포함하지 못한다고 합니다... 이거 해결해보려고 삽질(common/config/SwaggerConfig.kt)을 해 봤는데, 우선 text로는 request body라고 넣어주는데는 성공했으나 불충분하다면 API가 request body를 사용하지 않도록 재설계해야 할지도 모르겠네요.
등록 전 확인