드디어 자바 학습 구간이 끝나고 Spring이 시작되었다!
첫 개인 과제는 Spring을 이용한 일정관리 앱 api 만들기
먼저 API 명세서, ERD를 작성하고 진행한다.
참고
API 명세서란?
API 명세서란 API명, 요청 값(파라미터), 반환 값, 인증/인가 방식, 데이터 및 전달 형식 등 API를 정확하게 호출하고 그 결과를 명확하게 해석하는데 필요한 정보들을 일관된 형식으로 기술한 것을 의미합니다.
명세서를 작성할 수 있는 여러가지 툴이 있지만 그 중 PostMan을 이용한 방법을 소개하고자 글을 작성한다.
1. 컬렉션 생성
1. 상단 New 클릭 -> Collection 혹은, Create Collection 선택
- 우측 New Collection 하이라이트 된 부분 클릭 후 이름 설정
2. Request 생성
1. 생성된 collection에 우측 점 세개 클릭하여 Add request 선택
2. 메서드, Url 설정
3. Request 이름 변경
4. 우측 상단 No environment 클릭 후 Create Environment
위와 같이 작성해 변수를 등록해 사용할 수 있다. (url, param, Authorization 등)
3. Request 문서 작성
1. 우측 하이라이트 된 Documentation 클릭
2. 위 화면에 적절한 설명 작성
4. Request 묶기 (폴더 활용)
1. 좌측 컬렉션 이름 옆 점 3개 클릭
2. Add folder 클릭
3. 폴더 안으로 request 옮기기
4. 폴더에 관한 설명/이름 추가
마무리
잘 완성 된 모습
테스트 한 URL을 바로 example 로 추가할 수 있다는데, 그건 개발하며 추가 예정
.