codestates / codestates/GongJang
[ ✍️ Dev Log] 양진영 / 2021-12-14
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
### 오늘은 어떻게 프로젝트에 기여했나요?
- 서버 보안 강화 : 관리자 계정에 대한 정보는 환경변수로 저장 후(Dotenv 사용), 초기 seed데이터로 생성하여 어떤 요청에도 생성 및 변경할 수 없도록 수정
- 코드 리팩토링 : API 요청에서 들어오는 Parameter의 변수명을 단수(posts_id -> post_id)명으로 일괄 적용하여, API 요청에 혼동이 없도록 수정
- 배포환경에서의 에러 테스트 및 전반적인 점검
### 오늘의 프로젝트에서 힘든 점은 무엇인가요?
오늘은 그 동안 진행된 프로젝트의 전반적인 점검을 했음.
API문서를 보던 중, 팀원 간 명확한 기준을 세우고 작성한 것이 아니었기에 일관성이 없다는 점이 눈에 들어옴.
작성할 당시에는 크게 눈에 띄지 않았으나, 문서의 내용이 많아 지면서 비규격화 된 것이 API 문서를 읽는 데 어려움을 줄 수 있겠단 생각이 듦.
더욱이, 오늘 오전에 프론트엔드 팀원과 백엔드 팀원이 소통하던 내용 중에 어떤 params는 복수형인데, 어떤 params는 단수형이라
이것이 원인이 되어 에러를 발생시켰던 것이 기억남.
이에 따라, API 문서를 백엔드 팀원분과 전반적으로 검토하고, 일관되게 작성될 수 있도록 수정함.
다행히, API 문서 변경에 따른 코드 변경은 워낙 VScode가 잘 되어 있어서 어렵진 않았음.
문서를 작성할 때는 먼저 작성 기준을 세우자.
### 내일은 프로젝트에 기여하기 위해 무엇을 해야 하나요?
- [ ] 코드 리펙토링 및 전반적인 점검
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.