과제 개요
회사소개
마피아 컴퍼니
30명 규모의 음악사업분야 IT 벤처기업으로 '마음만은 피아니스트', 'MyMusicSheet', 'KOKOMU' 등 국내외 음원 & 악보 플랫폼 서비스 사업을 하고 있습니다.
과제 기간
2021.11.04-2021.11.06
필수 기술스택
neo4j GraphDB
사용 기술스택
- neo4j GraphDB
- Typescript
- Nestjs
- Nodejs
개발요구사항
-
화면별 Read API 요구사항
곡페이지-
해당
곡이 속한앨범을 가져오는 API -
해당
곡을 쓴뮤지션목록을 가져오는 API앨범페이지 -
해당
앨범을 쓴뮤지션목록 가져오는 API -
해당
앨범의곡목록을 가져오는 API뮤지션페이지 -
해당
뮤지션의 모든앨범API -
해당
뮤지션의곡목록 가져오는 API
-
-
Create, Update, Delete API 요구사항
곡생성 API앨범생성 API뮤지션생성 API뮤지션-곡연결/연결해제 API곡-앨범연결/연결해제 API뮤지션-앨범연결/연결해제 API 는 필요하지 않습니다. (구현 X)뮤지션-곡연결과곡-앨범연결이 되어있으면
GraphDB (neo4j) 에서뮤지션- [*] -앨범연결 여부를 뽑을 수 있습니다. 이 특성을 Read API에서 활용해주세요.
-
Neo4j DB 테이블 요구사항
뮤지션,곡,앨범은 각각의 테이블 (musician, song, album)로 구성되어야합니다.앨범안에는 여러곡이 속해있을 수 있습니다.- 한
곡에는 여러뮤지션이 참여할 수 있습니다. - 한
곡은앨범1개에만 들어가있습니다. 뮤지션은 여러 앨범을 갖고 있을 수 있습니다.뮤지션,앨범,곡데이터는 위 relation을 테스트할 수 있을만큼 임의로 생성해주시면 좋습니다.
-
FastAPI 프레임워크 요구사항
- Restful API로 구현하셨을 경우, FastAPI의 OpenAPI로 API 문서화해주세요.
과정
1. 사전 공부하기 - Neo4j DB, nestjs
마피아컴퍼니에서 요구한 Neo4j DB에 대해 잘 아는 팀원이 없었기 때문에 Neo4j DB에 대해 공부할 필요가 있었다. 그리고 나는 Nestjs와 Typescript에 대한 공부도 필요하기 때문에 이것들을 어떻게 공부해야할지 막막했다. 하지만 이전의 과제를 통해, 흔들리지 말고 하나씩 차근차근 해나가야한다는 교훈을 얻었기 때문에 Nestjs에 대해서 공부를 해갔다. (블로그 추가하기 Neo4j DB, nestjs)
2. 앨범의 cud, 테스트 - 팀원의 레퍼런스를 보고 생각하며 코드 작성하기
다른 팀원들에 비해 많이 부족하지만 일정부분을 맡아 배우면서 열심히 하고 싶었기 때문에 다른 팀원이 뮤지션에 대한 cud를 작성하는 모습을 화면공유를 통해 공부하면서 이를 통해 앨범의 cud 및 테스트 코드를 작성하기로 했다. 코드를 작성하는 팀원의 화면을 보면서 중간중간 궁금한 것을 물어보고 공부하면서 진행하였고, 이후 앨범의 cud 및 테스트 코드를 작성하였다. 아직은 많이 부족하여 혼자 했다기 보다는 팀원의 코드를 많이 참고했다. 하지만 기계적으로 따라하는 것이 아니라, 지속적으로 생각을 하면서 코드를 치려고 노력했다.
3. 포스트맨을 통한 api 문서 및 api 테스트
프리온보딩 코스에서 여러가지를 배우지만, 우리의 작업물을 다른 사람들에게 잘 보여주는 일의 중요성에 대해서 가장 크게 배우고 있다. 기존에는 코드를 잘 작성하는 것이 시작이자 끝이라고 생각했다. 하지만 프리온보딩 코스에서 이전의 생각이 좁은 생각이었다는 것을 많이 깨달았다. 잘 이해되게 볼 수 있는 README와 보기 매우 불편한 README는 큰 차이가 있었다. 이를 위해 Read me파일도 잘 작성하는 것이 중요하고, 그 중에서 API문서를 작성하고 테스트하는 것이 특히 중요하게 느껴졌다. 이를 위해 포스트맨에서 제공하는 API문서 작성과 API테스트를 할 수 있게 만드는 기능을 이용하여 여러번의 시행착오를 겪으며 완성하여 제출하였다.
그리고 포스트맨을 통해 api문서 작성을 블로그에 작성하였다. 링크는 다음과 같다. 포스트맨을 활용한 api문서 작성하기
배운점
1. 부족한 사람 배려하는법 - 질문할 수 있는 분위기 조성 및 상대의 이야기 경청하기
협업을 하는 것에 있어서 상대적으로 부족한 사람을 어떤 식으로 배려할 수 있는지를 배웠다. 내가 부족한 사람이었기 때문에, 같은 팀원들의 배려를 직접적으로 받으면서 느끼는 부분을 그대로 기억하면 되는 것이기 때문에 쉽게 배울 수 있었다. 화면을 공유하며 설명을 해주면서 코드를 작성하고, 모르는 부분에 대해서는 쉽게 질문할 수 있는 분위기를 만들며, 부족한 사람의 이야기를 잘 들어보고 어떤 부분이 부족한지를 잘 알아서 알려주는 등등의 것들을 경험하며 많이 코드적인 부분을 많이 배우기도 했고 배려하는 법을 배웠다. 특히 부족한 사람의 경우에는 자신의 부족한 부분에 대해서 거시적을 무엇을 몰라서 부족한지 알기가 어렵다. 그래서 상대적으로 잘 아는 팀원이 내 이야기를 잘 들어주고 무엇이 부족한지를 거시적으로 이해해서 설명해 주는 부분이 가장 좋다고 느껴졌다.
2. Nestjs, Typescript, Neo4j, Postman API 작성
이것들에 대해서 모두 잘 알게 된 것은 절대로 아니다. 하지만 전반적인 흐름이나 중요한 부분에 대해서는 감을 잡아가고 있다는 부분이 고무적이라고 생각한다. 모두 팀원들 덕분이다.
