운영 | 문서화(4)
-
Teams 에러 알람 설정 (WebHook)
사용 범위 서버 이상(500 에러)이 생길 때 Teams를 통해 알림를 보낸다. 방법 * Teams는 설치 상태라고 가정한다. 1. 알림이 가야하는 채널 생성 * 채널이 이미 있는 경우 만들지 않아도 됌 2. Incoming Webhook를 추가 오른쪽 하단 앱를 누르고 검색창에 incoming를 검색한다. 만든 팀이나 현재 존재하는 팀을 선택 한 후 커넥터 설정을 클릭한다. 3. Incoming Webhook 커넥터 설정 이름을 작성 한 후 만들기를 클릭하면 링크가 하나 생성된다. POST로 보내야 하는 링크이므로 복사 한 후 저장해 둔다. 4. 라이브러리 axios를 사용하여 메시지 POST 전송 Teams에 알림이 가는 상황에 맞는곳에 3. 에서 생성 된 링크로 axios로 POST로 값을 보내준다..
2022.07.26 -
git action CI/CD 버전 관리 방식 2022.01.05
-
swagger 긴 주석 작성 방법 (yaml파일) 줄 바꿈, 글씨 강조
swagger 작성 시 설명 해야하는게 많을 경우 주석이 길어지는데 이는 주석의 가독성이 떨어진다. 그래서 강조, 한 줄 내리기 등 표시를 해가며 나타내어야 한다. yaml파일을 사용했다. description 에서 수정한다. description 에서 | 가 중요하다. 꼭 있어야 하니 기억하자. 1. 줄 바꿈 문장이 끝나고 공백 두번을 넣으면 줄 바꿈이 된다. description: | Pet Store APIs This is a sample Petstore server Contains API Note: to manage the pet store 2. 글씨 강조, 기울임꼴 하기 ** , __ 로 묶으면 해당하는 글씨가 강조가 된다. _ 로 묶으면 기울임꼴이 된다. description: | **Pet*..
2022.01.03 -
릴리즈 노트 소수점 의미
릴리즈 노트의 번호는 회사, 조직 마다 다르다. 출처: https://tech.kakaoenterprise.com/113 에 방식을 따라서 사용하려고 한다. V.0.0.0 자리 별 의미 V.X.0.0 첫번째 자리 서비스 버전이 이전 버전과 호환이 되지 않을 정도의 업데이트 발생시 올라간다. V.0.X.0 두번째 자리 서비스 버전이 이전 버전과 호환이 가능하고 신규 기능이 추가, 삭제 되었을 경우 올라간다. V.0.0.X 세번째 자리 기존 api가 변경 되지않고 버그 같은 기능에 영향이 없는 경우 올라간다. 버그 수정 하나만 작성을 지양 한다. 어떤 버그가 개선되었다. 어떤 기능이 변경 되었다. 라고 한번에 파악하기 쉽게 작성한다.
2021.12.31