로지 - restAssured와 restdocs에 swagger ui 곁들이기

[kyY00n]

데 헷

[hgo641]

알차네여 고생하셨습니다 로지

질문

• restdocs는 restassured테스트를 실행할 때마다 새로 생기나요?
  • 그럼 생성할 때 마다 기존 파일에 덮어씌워지나요?
  • 기존에 있었던 restassured테스트를 삭제하면 restdocs 파일도 알아서 삭제되나요?
• build.gradle에서 swagger ui를 생성하는 태스크를 작성할 때, 태스크명 뒤에 프로젝트 이름을 덧붙이면 알아서 해당 프로젝트의 태스크로 지정이 되나요?
  (ex. 아래 코드에서 generateSwaggerUIRosieProject라는 이름으로 태스크를 생성하면 알아서 rosieProject와 연결이 되나요?)

tasks.withType(GenerateSwaggerUI) { // 5. swaggerUI 를 생성하는 task들은 전부
	dependsOn 'openapi3' // openapi3 이 실행된 이후에 실행되도록 설정
}

swaggerSources { // 6. swagger ui 생성에 필요한 source 설정.
	rosieProject { // ⭐️ rosieProject(이름은 프로젝트에 맞도록 변경) 라는 스웨거 ui의
		setInputFile(file("build/api-spec/openapi3.yaml")) // 소스 위치를 설정. (현재는 default 위치)
	}
}

// 7. rosieProject 에 대한 swagger ui를 생성하는 task.
generateSwaggerUIRosieProject {
	doLast { // ui 파일들이 생성되고 난 뒤
		copy { // 정적 리소스 디렉토리로 복사
			from outputDir.toPath()
			into "src/main/resources/static/docs/" // 원하는 곳으로 하시면 돼요
		}
	}
}

후기

restdocs랑 swagger같이 쓰는 거 처음보는 데 넘 신기했어요

내용이 복잡해서 설명하기 어려우셨을 것 같은데 전체 플로우를 간단하게 먼저 설명해주셔 이해하기 더 쉬웠습니다...
그래도 어렵긴 하네요...ㅠㅠ 근데 이건 그냥 제가 restdocs랑 swagger에 대한 지식이 부족해서 그런듯... 발표 흐름 자체는 좋았습니다!!
또, 소스코드에 주석으로 설명을 달아주셔서 이해하기 좋았습니다. 👍👍

[JJ503]

피드백

• 궁금했고 실습해보고 싶었던 주제라 흥미 있게 들었습니다.
• 예시들을 잘 만들어줘서 이해하기에 더 쉬웠습니다.
• 아직 restdocs도 swagger도 잘은 모르는데 로지의 발표 자료를 바탕으로 한번 실습해 봐야겠어요 ㅎㅎ

질문

• 원래 restdocs의 ui가 생성되고 swagger의 ui도 수행되는 것일까요?
  그렇다면 restdocs 파일 중 html에 파일을 열면 swagger ui가 적용된 페이지가 열릴까요?