API 설계
API 설계 내용을 구글 스프레드 시트 문서에 정리한다.
https://docs.google.com/spreadsheets/u/0/
① endpoints API 설계를 위한 항목을 작성한다. (종류, url, method, 기능, 설명)
② view(화면) 경로를 작성한다.
RootPath(/), error 페이지, UseCase 참고(로그인, 회원 가입, 게시판, 게시글, 검색)
③ api(데이터 전송) 경로를 작성한다.
회원 가입, 로그인 요청,
게시글 목록 조회, 게시글 조회, 게시글 등록/수정/삭제,
댓글 목록 조회, 댓글 조회, 댓글 등록/수정/삭제
+) api에 대한 버전 관리가 필요하다면 경로에 버전을 같이 작성한다. /v1/api/ or /api/v1/
+) 댓글은 게시글에 종속된다.
④ api spec 문서를 작성한다.
api(데이터 전송) 경로에 대해 구체적으로 어떤 데이터를 주고받는지 작성한다.
바꿔도 되는 정보와 바꿀 수 없는 정보가 설계 과정에서 드러나게 된다.
스프링 부트 프로젝트 생성
스프링 부트 프로젝트로 루트 디렉토리를 초기화하고 개발 바탕을 만든다.
홈페이지를 통해 만들어진 파일의 압축을 풀면 프로젝트 파일이 구성된다.
단, 파일 시스템에 직접 접근하여 압축을 풀어야 하므로 번거롭다.
gitignore 파일 수정
IntelliJ에서 기본적으로 제공하는 gitignore 파일에는 다른 에디터 또는 운영체제에 대한 내용이 없다.
gitignore.io를 통해 추가적으로 이에 대한 내용을 손쉽게 포함시킬 수 있다.
https://www.toptal.com/developers/gitignore
① Java, Gradle, Intellij+all, Windows, macOS, VisualStudioCode를 입력한다.
② 생성 버튼을 눌러 코드를 복사한다.
③ IntelliJ의 .gitignore파일에 붙여넣는다.
본 포스팅은 패스트캠퍼스 환급 챌린지 참여를 위해 작성하였습니다.
#패스트캠퍼스 #포트폴리오 #직장인자기계발 #환급챌린지 #포트폴리오챌린지 #패스트캠퍼스후기 #초격차패키지 #오공완
'Java > [패스트캠퍼스] 50일 포트폴리오 챌린지' 카테고리의 다른 글
[20일차] 10개 프로젝트로 완성하는 백엔드 웹개발(Java/Spring) (0) | 2023.08.27 |
---|---|
[19일차] 10개 프로젝트로 완성하는 백엔드 웹개발(Java/Spring) (0) | 2023.08.26 |
[17일차] 10개 프로젝트로 완성하는 백엔드 웹개발(Java/Spring) (0) | 2023.08.24 |
[16일차] 10개 프로젝트로 완성하는 백엔드 웹개발(Java/Spring) (0) | 2023.08.23 |
[15일차] 10개 프로젝트로 완성하는 백엔드 웹개발(Java/Spring) (0) | 2023.08.22 |