2024년 07월 15일 TIL

TL;DR

• 프로젝트 생성 시 입력하는 Group, Artifact, Name의 차이점을 알아냄
• Swagger API 문서 사용을 위해 레퍼런스를 찾아봄
• 스프링부트 코드를 둘러봄

한줄평

급하게 동아리 당일 일정이 잡혀서 과제에 시간투자를 많이 못했다.

회사 과제는 일단 간단한 세팅이랑 db연결까지 해놨는데 과제 스펙을 아직 다 못 읽었다.

스프링 부트 코드들을 살펴봤는데 약간 레고 같다는 느낌이 들었다. 기억이 또렷하진 않은데 예전에 Express 백엔드 개발 해볼 때는 직접 작성한 코드들이 많았던 것 같은데 스프링은 이미 대부분이 작성되어있어서 레고처럼 연결시켜서 개발하는 것 같다고 느꼈다.

Group, Artifact, Name의 차이점을 파악함.

링크

Group

회사명을 말한다. 말 그대로 어떤 그룹에서 이 프로젝트를 만들고 있느냐를 묻는 지점. 앞에서 본 naver, kakao, google 을 생각하면 된다. 내가 만드는 토이 프로젝트의 경우에는 회사에 소속되어 만드는 것이 아니기 때문에 그냥 공란으로 두었다. 상관 없다.

Artifact

내가 빌드할 프로젝트의 결과물의 이름이다. 내가 todolist 를 만들면 todolist 가 될 것이며, 주문 시스템을 만들 것이면 order 로 지을 수 있겠다.

Name

Optional 한 부분이다. 기본적으로 Artifact 를 입력할 때 함께 입력된다. Artifact 가 곧 프로젝트의 이름이기 때문에 함께 입력되지만, 함께 입력된 부분 뒤에 뭔가를 더 적으면 적히기는 한다. Artifact 가 공식적 이름, Name 은 비공식적 이름으로 생각하면 될 것 같다.

Package Name

위의 필수적인 이름들과 함께 전체 패키지명이 결정되는 것이다. 각 속성들을 종합해서 com.naver.shopping 과 같이 말이다!

Swagger

API 문서 만들어야 하는 일이 생겨서

1. wiki혹은 마크다운으로 관리
2. spring rest docs 사용
3. swagger 사용

의 3가지 선택지를 고려하였고,

이중 swagger에 대해 알아보기 위해 관련 아티클을 읽어봤음.

직접 수정해야하는 wiki, 세팅이 어려운 spring rest docs보다 자동으로 문서를 생성해주고 테스트까지 편한 Swagger가 가장 좋은 선택지라고 판단되어 swagger를 사용함.

다만 댓글에서 글쓰기가 제한적이고 코드가 지저분해진다는 의견이 있어 이를 고려해야 할 것 같음.

스프링부트 공부

1시간만에-끝내는-springboot-restapi 와 점프 투 스프링부트 을 읽어보면서 스프링부트 코드가 어떤느낌인지 알아봤다.