Skip to content

Comments

[feat/docs] Config 서버 API 연동 (우분투 계정 삭제) 및 API 명세서 작성#123

Merged
saokiritoni merged 16 commits intodevelopfrom
feat/#121-ubuntu
Sep 3, 2025
Merged

[feat/docs] Config 서버 API 연동 (우분투 계정 삭제) 및 API 명세서 작성#123
saokiritoni merged 16 commits intodevelopfrom
feat/#121-ubuntu

Conversation

@saokiritoni
Copy link
Member

@saokiritoni saokiritoni commented Sep 2, 2025

🌱 관련 이슈

🌱 작업 사항

Config 서버와 우분투 계정 생성 및 삭제 연결 테스트

  • 테스트 완료했고, 버그를 수정했습니다.
  • Config server에서 계정 삭제 http method를 delete가 아닌 post로 설정해놔서, 해당 부분은 일단 config server 요구사항대로 맞추기 위해 post를 호출했습니다. 나중에 개선이 필요할 것 같습니다.
  • 우분투 계정 삭제의 경우, 실질적으로는 Request가 삭제됩니다. (MySQL 기준)
  • 실제로 삭제하지 않고 soft delete로 상태만 update하도록 변경했습니다.

유저 웹 탈퇴

  • 유저가 웹사이트를 탈퇴하면, 남아있던 컨테이너들도 삭제가 되어야 하기 때문에, Request도 삭제되어야 합니다.
  • Request가 모두 삭제(soft delete)되도록 수정하였습니다.
  • 따라서 RequestStatusDELETED를 추가하였습니다.

짜잘한 수정

  • API 명세서를 전체적으로 수정하고 작성했습니다.
  • 0번은 인증없이 사용해야 하는 API (Config server용, 가입 및 로그인 용)
  • 1번은 관리자만 접근 가능한 API
  • 2번은 사용자까지 접근 가능한 API 로 분류했습니다.
  • 앞으로 문서는 이 format에 맞게 작성해주세요.

@kwdahun
Copy link
Contributor

kwdahun commented Sep 2, 2025

This pull request introduces significant improvements to the API documentation and structure, adds new DTO annotations for better Swagger/OpenAPI integration, and enhances request management by supporting soft deletion. The most important changes are grouped below:

API Documentation & Structure Updates

  • Introduced new API documentation interfaces: GroupApi and ConfigRequestApi, and updated controllers (GroupController, ConfigRequestController, AdminRequestController) to implement these interfaces for clearer separation and maintainability. [1] [2] [3] [4] [5] [6] [7] [8]
  • Standardized and clarified Swagger @Tag annotations across all API documentation files for improved grouping and readability in the generated API docs. [1] [2] [3] [4] [5] [6] [7]

DTO Enhancements for Swagger/OpenAPI

  • Added @Schema and validation annotations to request DTOs (CreateGroupRequestDTO, ApproveRequestDTO, RejectRequestDTO) to improve API documentation and enforce input constraints. [1] [2] [3]

Request Management Improvements

  • Added a soft delete feature to the Request entity via a new delete() method and introduced a DELETED status to the Status enum for better lifecycle management of requests. [1] [2]

Admin API Extensions

  • Expanded AdminRequestApi with endpoints for approving/rejecting requests, viewing resource usage, container info, and handling change requests, including detailed Swagger documentation.

Miscellaneous

  • Minor improvements to response DTOs and internal documentation for consistency.

Let me know if you want to dive deeper into any specific change or area!

@saokiritoni saokiritoni merged commit 47e1de0 into develop Sep 3, 2025
@saokiritoni saokiritoni deleted the feat/#121-ubuntu branch September 4, 2025 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[ feat ] Config Server API 연결 - 그룹 추가

2 participants