Springboot JPA kotlin 3. swagger / 스웨거

https://github.com/rcaninhu/springboot3-demo

GitHub - rcaninhu/springboot3-demo

오늘은 스웨거라는것을 붙여 보는 시간~

스웨거라는 문서와 도구가 있다 

라이브러리 추가.

// openapi - swagger
implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2")

## application.yaml

springdoc:
  swagger-ui:
    enabled: true ## 활성화 유무
    path: /swagger-ui.html # 스웨거페이지 기본이 저 주소로 되어 있지만 변경하실분은 변경.

 

 

 

타부서 타팀 혹은 타 업체

외부로 api로 뭔가 오픈 해줘야 하는경우 스웨거 문서로 전달해주면 테스트 까지 가능하니까 편하다 (물론인증이나 기타등등 처리가 추가 필요 하지만)

 



try it out을 누르면 해당 api를 테스트 할 수 있다.

 

기본값으로 넣어 준것이 있다면 기본값으로 넣어준다. 없으면 자료형(?)이 들어가 있다. 

기본값과 설명을 추가를 해보면 이렇게 추가 하면

@Schema(description = "게시판 저장 요청 객체")
data class BoardSaveRequest(

    @field:Schema(
        description = "제목",
        example = "제목입니다",
    )
    val title: String,
    @field:Schema(
        description = "내용",
        example = "내용을 입력해주세요.",
    )
    val contents: String,
)

이렇게 작성해주면. 아래와 같이 볼수 있다. example 을 입력해주면 기본 값으로 넣어준다. 

try it out~

엑셀 또는 워드로 문서 만들어서 배포 하던때가 ... 생각난다...

다음은 내 라이브러리 이대로 괜찮은가? 시간을 ~

OWASP library scanner // dependency-check~