Springboot
-
spring boot logback.xml 맥OS에서 파일 생성 문제Springboot 2022. 8. 14. 10:12
문제점 macOS에서 testcase 동작시에도 weblog를 남기게 하였는데 해당 경로는 배포 경로와 동일한 /var/log/webserver를 사용하였다. 문제는 여기서 부터 시작 intellij가 root권한으로 실행되지 않기 때문에 /var/log/webserver 에 폴더를 자동 생성하거나 그 경로 하위에 로그 파일을 생성하는 것도 실패하였음. 해결책 나의 경우 총 4개의 profile을 운영중이다. - real (서비스 프로필) - dev (개발 프로필) - junit, local (로컬 또는 테스트 케이스 동작시) 권한문제로 logback이 파일을 생성하지 못하는 이슈를 해결하고자 위와 같이 분기처리 하였음 ${user.home} 을 사용하여 유저 경로 하위에 로그를 생성한다. 느낀점 사실..
-
[1] Spring REST Docs 이용해 API 문서 작성하기Springboot 2022. 3. 3. 21:07
안녕하세요. 이 글은 제가 서버 개발자로 일하며 회사내 동료, 외부 업체 등에 Open API 형태로 API 문서를 제공했던 경험들을 공유 합니다. 1. Swgger가 있잖아요 ? 먼저 Swagger 이야기를 해볼게요. Swagger를 사용했을때 단점은 다음과 같았습니다. 비즈니스 코드 곳곳에 어노테이션을 추가해야 합니다. 이러다 보니 문서를 위한 어노테이션 및 주석을 달아야 하고 해당 어노테이션이 추가될때마다 관리도 되지 않고 문서를 위한 작업을 해야했습니다. 보는 사람에 따라 코드 가독성이 떨어지기도 합니다. 저의 경우 그랬습니다. 하지만 가장 좋지 않다고 생각했던것은, 예전에 API의 A값의 의미는 "a" 였는데 개발을 진행하다보니 혹은 릴리즈를 하다보니 "b"로 바뀌는 경우 해당 어노테이션을 수정..
-
[1] API 반환 값 설계 및 구현Springboot 2021. 12. 12. 06:47
이용 도구 및 개발 환경 JAVA, Spring boot, AWS, Intellj, RestDoc, Postman 나의 고민 저는 회사에서 Open API 형태로 다수의 국내 및 해외 기업에 서비스를 제공하고 있습니다. 백엔드 개발자로 운영을 하다보니 여러가지 포인트에서 개선하고 싶었고 구체적으로 다음과 같은 일을 진행했습니다. 1. 테스트 케이스 기반의 API 사용 명세 문서가 자동 생성 되어야 한다. Spring RestDocs 로 구현 2. 서버에서 정의한 에러코드 문서화 3. 그 외 기타 에러에 대해서도 처리 ( JSON parse error, req body validation error .. ) API 사용자가 서비스 이용시 에러가 발생하면 사용자는 반환된 에러코드를 또 다시 검색 해야하는 불..