swagger
-
[appling] Controller 추가하기 (Api Annotation 추가, Swagger 적용)appling 프로젝트 2024. 9. 8. 13:10
🔴 Controller 만들기지금까지 Service만 작성하고 실제로 Controller는 작성하지 않았다. 이제 Controller를 적용해보자.🟠 Controller 적용하기🟢 기존 Controller 쓰기@RestController@RequestMapping("/api/v1")public class ProductController {}RestController를 적용하고 기본 값으로 /api/v1을 붙여주려고 한다. 근데 만드는 Controller마다 붙이는게 너무 귀찮을거 같아 Annotation으로 설정하려고 하다.🟢 @ApiController 만들기@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@RestController@Re..
-
[appling] 프로젝트 기초 설계 (Swagger 설정)appling 프로젝트 2024. 8. 30. 00:30
🔴 프로젝트 기초 설계간단한 프로젝트라도 기본 설정을 먼저 한 후에 진행하려고 한다.🟠 SwaggerSpring에서 문서는 Swagger와 Restdoc이 있는데 예전에는 테스트코드가 강제되는 Restdoc을 선호했으나 요즘에는 Swagger를 좀더 선호하는 편이다. 그 이유는 Restdoc은 spring에서만 사용하고 있는 반면 Swagger는 다른 api에서 제공이 되고 있어 api에 접근하는 앱, 프론트 개발자 분들이 따로 익히거나 알 필요성이 없이 바로 적응이 가능하기 때문에 더 선호한다.또한 테스트 코드의 강제는 꼭 restdoc이 아니더라도 jacoco와 같은 설정으로 강제할 수 있기 때문에 큰 문제가 되지 않는다고 생각한다.Restdoc으로 Swagger 파일을 생성하여 굳이 Restdo..