refactor(topics): 멀티 에이전트용 지식 재편 — _Common(공통 기본기) + Domain_* 구조
에이전트 8종(대화형/프로그래머 C·S/디자이너/설계자/기획자/QA/PD/PM)에게 [공통 기본 능력 + 롤별 Specialty] 2층으로 지식을 주입하기 위한 재분류. 문서 내용·포맷은 무수정, 폴더 이동만 (6,372개 문서 수 보존 확인). - Topic_Programming → Domain_Programming (내부 구조 보존) - Topic_Graphic → Domain_Design - Topic_Business → Domain_Product - Topic_General → Domain_General - _Common 신설: Math(구 Topic_Math_Specialty), Reasoning(구 General/From_Thinking & Reasoning), Reasoning_Creativity(구 General/From_창의성), Communication(Poetic_Blog_Writing + From_writing) - 타 도메인의 From_* 폴더는 유지 (출처 표기일 뿐, 이미 도메인에 맞게 분류된 문서) - 빈 폴더 정리 (memory/procedures) - 에이전트→폴더 매핑은 workspace의 .astra/agent-knowledge-map.json (9개 에이전트) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,29 @@
|
||||
---
|
||||
category: Backend
|
||||
tags: [auto-wikified, technical-documentation, backend]
|
||||
title: OpenAPI / Swagger
|
||||
description: "OpenAPI와 Swagger는 RESTful API를 설계, 테스트 및 문서화하기 위한 표준 사양과 대화형 도구 모음입니다 [1, 2]."
|
||||
last_updated: 2026-05-04
|
||||
---
|
||||
|
||||
# OpenAPI / Swagger
|
||||
|
||||
## 📌 Brief Summary
|
||||
OpenAPI와 Swagger는 RESTful API를 설계, 테스트 및 문서화하기 위한 표준 사양과 대화형 도구 모음입니다 [1, 2]. 개발자가 추가 도구 없이도 API 엔드포인트를 수동으로 탐색하고 상호작용할 수 있도록 지원하며, 클라이언트 코드 생성 프로세스를 간소화합니다 [1, 2]. 현대적인 백엔드 프레임워크들은 코드를 기반으로 이러한 API 문서를 자동 생성하고 동기화할 수 있는 강력한 통합 기능을 제공하고 있습니다 [3, 4].
|
||||
|
||||
## 📖 Core Content
|
||||
* **인터랙티브 API 테스트 및 탐색**: Swagger는 API 엔드포인트를 쉽게 테스트하고 탐색할 수 있는 대화형 인터페이스(Swagger UI)를 제공합니다 [2]. 이를 통해 개발자는 별도의 외부 도구나 클라이언트 앱을 구축할 필요 없이 수동으로 애플리케이션과 상호작용하며 기능을 검증할 수 있습니다 [2].
|
||||
* **문서 자동화와 코드 동기화**: API 문서화 방식은 채택한 프레임워크에 따라 크게 달라집니다.
|
||||
* **NestJS**: 데코레이터와 DTO를 활용하여 Swagger/OpenAPI 문서를 자동으로 생성하며, API 문서가 실제 코드와 항상 동기화된 상태를 유지하도록 돕습니다 [3, 4].
|
||||
* **Express**: 자동화 지원이 부족하여 `swagger-jsdoc`이나 별도의 문서화 도구를 사용해 수동으로 Swagger를 설정해야 합니다 [4].
|
||||
* **Django (DRF)**: `drf-spectacular`와 같은 라이브러리를 활용하여 DRF API 문서화를 자동화할 수 있습니다 [5].
|
||||
* **Encore**: 보일러플레이트를 줄인 Encore 프레임워크에서도 자동으로 OpenAPI 스펙을 생성하여 제공합니다 [6].
|
||||
* **클라이언트 코드 생성 및 협업 강화**: JSON 포맷 등으로 제공되는 OpenAPI 엔드포인트(예: `/api-docs`)는 API 계약(Contract)을 명확하게 유지하는 표준화된 문서 역할을 합니다 [2]. 이 스펙은 인터페이스 및 데이터 모델 생성에 사용될 수 있어, 마이크로서비스 환경 등에서 클라이언트 코드(SDK)를 생성하는 과정을 크게 단순화시킵니다 [1, 2]. 결과적으로 개발팀 간에 API 설계 및 기능에 대한 시각을 일치시키고 협업과 개발 속도를 가속화하는 데 기여합니다 [7].
|
||||
|
||||
## ⚖️ Trade-offs & Caveats
|
||||
이 주제와 관련하여 OpenAPI/Swagger 적용 자체에 따른 심각한 시스템적 부작용이나 성능 저하에 대한 내용은 소스에 관련 정보가 부족합니다.
|
||||
|
||||
다만, API 문서를 구현하는 기술적 선택에 따른 제약 사항(Trade-off)은 존재합니다. Express와 같이 구조화되지 않고 유연성을 강조하는 프레임워크에서는 API 문서화를 위해 수동 설정과 지속적인 유지보수 작업이 요구됩니다 [4]. 반면, NestJS나 Spring Boot와 같이 구조화된 프레임워크에서는 자동 생성의 이점을 누릴 수 있지만, 이를 위해 특정 데코레이터나 어노테이션 패턴(DTO 등)을 강제적으로 코드베이스 전체에 적용해야 하므로 학습 곡선이 발생하고 프레임워크에 대한 종속성이 높아진다는 제약이 있습니다 [4].
|
||||
|
||||
---
|
||||
*Last updated: 2026-05-03*
|
||||
Reference in New Issue
Block a user