GLUE 서비스의 Blog Service에 방문해주셔서 감사합니다. 해당 Repository는 GLUE 서비스의 블로그와 구독 CRUD 기능에 대한 내용을 담고 있습니다.
| Profile | Name | Role | Task |
|---|---|---|---|
 |
김현겸 kylo-dev |
DevOps, Architecture, Backend |
MSA 환경 시스템 아키텍처 설계, Infra 구축, GitOps 구축, Blog 서버 API 개발, ElasticSearch 검색 API 개발 |
 |
공예영 yeyounging |
Frontend(Next.JS), UI/UX, Design |
이러고 저러고 |
Glue 서비스에서 Blog-Server는 블로그와 구독에 관한 데이터를 메인으로 처리합니다. 다른 마이크로 서비스의 데이터나 처리가 필요한 경우 Open Feign 라이브러리를 이용하여 다른 서비스와의 통신을 처리하였습니다.
- 회원 가입
- 회원가입 시, 개인 블로그를 생성합니다.
- 블로그 마이페이지
- 블로그 마이페이지를 조회합니다.
- 블로그 마이페이지 정보를 수정합니다.
- 블로그 페이지
- 블로그 정보를 조회합니다.
- 추가로, 최신 게시글 4개, 관련된 이미지, 최근 자주 사용한 해시태그를 조회합니다.
- “게시글 보기” 버튼을 통해 블로그의 전체 게시글 목록을 페이징하여 조회합니다.
- 검색 페이지
- 게시글 제목과 해시태그를 기반으로 게시글을 검색합니다.
- 검색된 게시글의 정보를 조회합니다.
- “블로그 보기” 버튼을 통해 작성자의 블로그를 조회합니다.
- 구독 페이지
- 로그인한 사용자는 타 블로그에 구독을 요청합니다.
- 로그인한 사용자는 구독한 블로그를 취소합니다.
- 내가 구독한 블로그의 정보와 게시글 정보 목록을 페이징하여 조회합니다.
- 나를 구독한 블로그의 정보와 게시글 정보 목록을 페이징하여 조회합니다.
저희 프로젝트는 MSA 환경 서비스로 Gateway Server에서 여러 마이크로 서비스의 Swagger를 통합하여 관리하였습니다.
- 다른 마이크로 서비스와 통신하는 API 경우, Swagger 'summary'에 'Open Feign'이라 작성하여 프론트엔드가 연동하는 API 구분하였습니다.
- Blog 서비스의 흐름에 따라 해당 API를 어느 페이지에 사용하는지, 어떤 DTO를 사용하며, example이 무엇인지 등을 구체적으로 명시하였습니다.
Swagger 보기
화면 UI 보기
- 블로그 페이지 (Read)
- 블로그 마이 페이지 (Read, Update)
- 구독 페이지 (Read)
- 검색 페이지 (Read)
4.1 검색 페이지 (블로그만 보기, 게시글만 보기)
프로젝트 구조 보기
📦
.github
└─ ISSUE_TEMPLATE
└─feature_request.md
└─ pull_request_template.md
└─ workflows
└─ blog-server.yaml
.gitignore
Dockerfile
README.md
build.gradle
└─ src
├─ main.java.com.justdo.plug
│ └─ blog
│ ├─ BlogApplication.java
│ ├─ domain
│ │ ├─ blog
│ │ │ ├─ Blog.java
│ │ │ ├─ controller
│ │ │ │ └─ BlogController.java
│ │ │ ├─ dto
│ │ │ │ ├─ BlogRequest.java
│ │ │ │ └─ BlogResponse.java
│ │ │ ├─ repository
│ │ │ │ └─ BlogRepository.java
│ │ │ └─ service
│ │ │ ├─ BlogCommandService.java
│ │ │ └─ BlogQueryService.java
│ │ ├─ common
│ │ │ └─ BaseTimeEntity.java
│ │ ├─ member
│ │ │ ├─ MemberClient.java
│ │ │ └─ MemberDTO.java
│ │ ├─ post
│ │ │ ├─ PostClient.java
│ │ │ └─ PostResponse.java
│ │ ├─ recommendation
│ │ │ ├─ RecommendationClient.java
│ │ │ └─ RecommendationDTO.java
│ │ └─ subscription
│ │ ├─ Subscription.java
│ │ ├─ controller
│ │ │ └─ SubscriptionController.java
│ │ ├─ dto
│ │ │ ├─ SubscriptionRequest.java
│ │ │ └─ SubscriptionResponse.java
│ │ ├─ repository
│ │ │ └─ SubscriptionRepository.java
│ │ └─ service
│ │ ├─ SubscriptionCommandService.java
│ │ └─ SubscriptionQueryService.java
│ └─ global
│ ├─ config
│ │ ├─ FeignConfig.java
│ │ └─ SwaggerConfig.java
│ ├─ exception
│ │ ├─ ApiException.java
│ │ └─ ExceptionAdvice.java
│ ├─ response
│ │ ├─ ApiResponse.java
│ │ └─ code
│ │ ├─ BaseCode.java
│ │ ├─ BaseErrorCode.java
│ │ ├─ ErrorReasonDto.java
│ │ ├─ ReasonDto.java
│ │ └─ status
│ │ ├─ ErrorStatus.java
│ │ └─ SuccessStatus.java
│ ├─ s3
│ │ ├─ S3Service.java
│ │ └─ S3config.java
│ └─ utils
│ ├─ JwtProperties.java
│ └─ JwtProvider.java
└─ test.java.com.jusdo.plug
└─ blog
└─ BlogApplicationTests.java
©generated by Project Tree Generator
The project's folder structure is as follows: According to MVC pattern of Spring boot. We folderized every contents in to Model, Controllers and Service. Each domain has own Model Contollers and Services.
The languages, libraries, frameworks, and tools used in the project are as follows:
- Languages: Java 17
- Build: Gradle, Docker
- CI/CD: Docker, Github Actions, Argo CD, Kubernetes, Helm
- Tools: Intellij, Datagrip, Swagger
- Libraries and Frameworks: SpringBoot 3.2.4, JPA
- spring data jpa, mysql
- spring web, valiation
- spring cloud config, open feign
- lombok
- spring cloud aws
- jjwt-api, jackson
- springdoc-openapi
- spring boot actuator