개요

Django REST Framework 기반 AI_Trend 백엔드 REST API 명세입니다. 상세 스키마·Try it out은 Swagger에서 확인하세요.

<aside> 🔗

Base URL (운영) https://aitrend.홈페이지.한국/

Swagger UI /api/docs/ · ReDoc /api/redoc/ · OpenAPI JSON /api/schema/

</aside>

<aside> 💡

문서 구조는 Notion 공식 샘플 API 레퍼런스 템플릿과 같이 기본 정보 → 엔드포인트(DB) 순으로 읽을 수 있게 맞춰 두었습니다.

</aside>

기본 정보

시작하기

이 문서는 AI_Trend REST API의 개요·규칙·엔드포인트 목록을 제공합니다. 요청/응답 필드 상세는 Swagger(Try it out) 또는 GET /api/schema/ OpenAPI JSON을 참고하세요.

규칙

• Base URL: 운영 도메인 + /api/ 접두사(예: GET /api/health/). 클라이언트는 HTTPS를 사용합니다.
• 형식: REST 스타일, 요청·응답 본문은 JSON(application/json)이 기본입니다.
• GET: 메시지 본문(body) 없이 Path·쿼리 스트링으로 파라미터를 전달합니다.
• 필드 명명: Django 모델·DRF Serializer 관례에 따라 응답은 주로 snake_case입니다.

페이지네이션

DRF PageNumberPagination 기준으로 page(페이지 번호, 1부터)와, 클래스에 따라 page_size(한 페이지당 건수)를 쿼리로 넘깁니다. 구현은 common/pagination.py.

• /api/dashboard/news/ · /api/dashboard/social/ (DashboardPageNumberPagination): 기본 50건/페이지. ?page=2&page_size=50처럼 조합 가능. page_size는 최대 100까지(클라이언트가 줄 수 있는 상한).
• /api/analyzer/ 통합 분석 목록·타입별 분석 목록 (AnalysisResultPagination): 기본 20건/페이지. 예: ?page=1&page_size=20. page_size 최대 100.
• /api/user_qa/history/ (QueryHistoryPagination): 기본 100건/페이지. page_size 최대 200.
• 상세·단건 조회(…/{id}/ 등)는 페이지네이션 없음.
• 목록 API 일부는 Redis에 COUNT(*) 결과를 캐시해 페이지 이동 시 DB 부하를 줄입니다(list_cache_prefix + ListCacheCountPageNumberPagination).

요청 제한