[Java Project] Part 2. 게시판 서비스 만들기 - 유즈케이스2 및 API 설계

1. 유즈케이스2

(1) 유즈케이스 그리기

• 시스템과 엑터의 관계는 실선으로 표기한다.
• DB는 인증과정과 게시판 보기, 게시글 보기, 게시글 및 댓글 관리 와 연결이 되어야 한다.
• Export as > SVG 를 통해 저장한다.
  • file name : usecase.svg
  • 깃허브에서 폴더 찾아서 저장한다. 
  • 이때 기존에 생성해두었던 파일과 이름이 동일함으로 replace할 것인지 묻는데 ok를 해주고 커밋 메시지를 작성한다.
    • 커밋 메시지는 앞서 정했던 전략을 사용하여 작성한다. (이슈번호 + 제목 + 왜 작성했는지)
    • #4 - 게시판 서비스 유케이스 그림 완성
  • 깃 크라켓에서 description을 작성할 수 있다.
• 유즈케이스 커밋까지 완료하였으면, pull request를 한다.
  • 깃허브의 Pull requests로 이동하여 추천해주는 노란 박스의 compare&pull request를 해도 되고, new pull request를 통해 작성할 수 있다.
  • 이름 : 게시판 서비스 유즈케이스 작성
    내용:  draw.io 을 이용하여 유즈케이스 벡터 이미지 생성했다.
• merge pull request를 진행한 이후에는 브랜치를 꼭 삭제해준다.
  • 삭제해도 기록으로 남기도 하고, 다시 만들 수 있기 때문에 마음 놓고 삭제해줘도 된다.
• Project로 이동하면 Done을 이슈가 이동한 것을 확인할 수 있다.

<추가>

• File > Publish > Link 
  • lightbox만 체크하여 create
  • Link를 복사하면 빠르게 이미지를 확인할 수 있다.

 

2. API 설계

• 개발 시작 전, Project에서 게시판 api 만들기 카드를 In process로 이동시킨다.
• 구글 스프레드 시트를 활용하여 api 설계를 작성할 것이다.
• 컬럼 : 종류, url, method, 기능, 설명
• 이때 상세 내용은 유즈케이스를 참고하면서 작성한다.

패스트 캠퍼스 강의 내용 중 api 설계 과정에서 작성한 구글 문서

• PUT은 통으로 치환할 때 쓰이며, PATCH는 일부만 수정할 때 쓰인다.
• 입력 데이터 구상을 할 때,
  • 닉네임은 id에 종속됨으로 생략할 수 있다.
  • 수정이 일어날 때, id는 수정되지 않도록 하는 것이 좋다.

• 완료된 설계 내용은 Project 카드 내에 comment를 통해 남겨 놓을 수 있다.

 

---

 

본 포스팅은 패스트캠퍼스 환급 챌린지 참여를 위해 작성하였습니다.

https://bit.ly/43z0P6S

 

 

#패스트캠퍼스 #포트폴리오 #직장인자기계발 #환급챌린지 #포트폴리오챌린지 #패스트캠퍼스후기 #초격차패키지 #오공완