반응형 웹개발80 API 문서 작성하는 방법 프로젝트를 진행하면서 API 문서를 작성하는 방법에 대해서 공부했다. 프로젝트 repository wiki에 업로드하여 팀원 모두와 공유하기로 하고 API document를 작성하는 방법에 대해서 검색을 해봤다. 그러던 중 좋은 자료를 발견하였고 이에 맞춰서 wiki를 작성했다. (자료 출처 : gist.github.com/iros/3426278) 먼저 꼭 들어가야 하는 내용들이다. API Title - api 이름 URL - api 경로 Method - request 방식 (get | post | delete | put) Data Params - post 요청시 body안에 넣어줄 값 URL Params (만약 있을 경우) Required - url params로 넘길 값 Success Response.. 2020. 12. 30. [2020.12.27] 12월 넷째주 회고록 이번 주는 프로젝트를 진행하였다. 백엔드 포지션에서 api를 만들고 db를 설계한 뒤 aws를 통해 서버를 배포하는 역할을 맡았다. 간단한 프로젝트여서 api와 db 모두 설계가 금방 끝났었다. 그러나 프로젝트를 진행하다 보니 점점 api와 db 설계의 허점이 보였고 계속해서 설계를 수정 보완해나가며 진행하였다. 계속 설계를 수정하다보니 결국 api와 db를 전부 밀고 다시 진행하게 되었고 내가 예상했던 거보다 api를 만드는 시간이 더 길어졌다. 마감 시간까지는 완료하였으나 설계의 중요성을 다시 깨달았으며 설계에는 시간과 공을 들여 신중하게 진행해야 함을 깨달았다. 프로젝트 전체 기간이 짧을 것으로 예상되어 설계에 반나절 정도만 소요해서 급하게 마무리를 지었는데 급하게 마무리한 설계가 너무 후회되었다... 2020. 12. 27. Amazon EC2 이용해서 서버 배포하기 오늘은 서버를 배포하는 과정을 공부했다. Amazon에 프리티어 계정으로 등록한 뒤 인스턴스를 생성하고 Node.js로 만든 프로그램을 배포해보았다. 팀 프로젝트를 하면서 서버와 클라이언트를 따로 작업하게 되었는데 클라이언트에서 테스트하기 편하도록 Amazon을 이용해 배포를 진행하였다. (팀 프로젝트 코드를 올릴 수 없으니... 임의로 작성한 간단한 서버 코드이다.) const express = require('express'); const app = express(); const config = require('./config/index'); const { SERVER_PORT } = config; app.get('/', (req, res) => { res.json({text: "HELLO"}) }).. 2020. 12. 22. [2020.12.20] 12월 셋째주 회고록 오랜만에 회고록으로 블로깅을 다시 시작하려 한다. 그동안 공부하기 바빠 블로깅을 할 시간이 없었는데 이제 조금 여유가 생길 것 같다. 그동안 보안과 가입할 때의 인증 로직을 작성하는 것과 AWS를 이용한 배포 과정 및 RDS로 DB 사용하는 과정에 대해서 공부했다. 처음에는 너무 어려워서 매일 새벽까지 했지만 막상 완성하고 나니 왜 이렇게 고생했나 싶었다. 이제 공부했던 내용들을 가지고 프로젝트에 들어가려 한다. 내가 잘할 수 있을까 걱정되지만 그래도 최선을 다하겠다. 막상 프로젝트에 들어가려니 여러 가지 복잡한 심경이 오고 간다. 꼭 잘 마무리해서 좋은 포폴이 되었으면 좋겠다. 2020. 12. 20. 이전 1 2 3 4 5 6 7 8 ··· 20 다음 반응형
