Consumer 서비스 연동 가이드 문서 작성
ID: 85f92598-598d-4511-bdad-6c4f388445af
## 작업 내용
`docs/api/consumer_integration_guide.md` 연동 가이드 문서 작성
### 포함할 내용
1. **개요**: 9WAY OAuth2 Provider 소개, 지원 Grant Type
2. **사전 준비**:
- 9WAY 어드민에서 OAuth Application 등록 방법
- client_id, client_secret 발급
- redirect_uri 설정
- scopes 설명 (profile, email, diagnoses, strengths)
3. **Authorization Code Grant 흐름**:
- 단계별 설명 (authorize → callback → token)
- PKCE 지원 설명
- 코드 예시 (Rails + OmniAuth)
4. **Client Credentials Grant 흐름**:
- 서버 간 통신용
- 토큰 발급 curl 예시
5. **API 호출 예시**:
- GET /api/v1/me (프로필 조회)
- GET /api/v1/users/:id/diagnoses (진단 이력)
- GET /api/v1/users/:id/strength_profile (강점 프로필)
- 각 응답 JSON 예시 포함
6. **사용자 식별**:
- provider_uid 매핑 방법
- Consumer DB에 저장할 필드
7. **에러 처리**:
- 401, 403, 404 응답 처리
- 토큰 갱신 (Refresh Token)
8. **Rails Consumer 빠른 시작**:
- Gemfile 설정
- OmniAuth initializer
- 콜백 컨트롤러 예시
- API 클라이언트 서비스 객체 예시
## 참고
- 기존 doorkeeper 설정: `config/initializers/doorkeeper.rb`
- API 컨트롤러: `app/controllers/api/v1/`
- API 라우트: `config/routes.rb`의 api namespace
## 완료 기준
- 개발자가 문서만 보고 Consumer 서비스를 연동할 수 있는 수준
- curl 예시와 Rails 코드 예시 모두 포함
첨부 이미지
이미지 추가 (Ctrl+V로 붙여넣기 또는 클릭)
JPEG, PNG, GIF, WebP / 최대 10MB
활동 로그
-
팀팀리드 상태 변경: 리뷰 → 완료
2026년 03월 01일 03:55:57
-
Ddocs-dev 상태 변경: 할 일 → 리뷰
2026년 03월 01일 03:55:39
-
Ddocs-dev Consumer 연동 가이드 문서 작성 완료
2026년 03월 01일 03:55:38
상세 보기
## 작성 파일\n- `docs/api/consumer_integration_guide.md`\n\n## 문서 구성 (10개 섹션)\n1. 개요 - OAuth2 Provider, 지원 Grant Type\n2. 사전 준비 - Application 등록, Scopes 설명\n3. Authorization Code Grant - PKCE 포함 단계별 흐름, curl 예시\n4. Client Credentials Grant - curl 예시\n5. API Endpoints - /me, /diagnoses, /strength_profile 실제 응답 JSON\n6. 사용자 식별 - provider_uid 매핑\n7. 에러 처리 - 401/403/404, Refresh Token\n8. Rails Consumer 빠른 시작 - Gemfile, Strategy, Controller, API Client\n9. Consumer 마이그레이션 테이블\n10. CORS 설정\n\n## 실제 코드 반영\n- doorkeeper.rb: 스코프(profile, email, diagnoses, strengths), 2시간 만료, PKCE 강제\n- profiles_controller.rb: /me 응답 (id, email, name, locale, role 등)\n- diagnoses_controller.rb: diagnoses 응답 (status, locale, diagnosis_type 등)\n- strength_profiles_controller.rb: strength_profile 응답 (top_dna, top_way, scores 등)\n- kakao.rb: OmniAuth strategy 패턴 참고하여 nineway strategy 예시 작성
-
Ddocs-dev 작업 시작 - 연동 가이드 문서
2026년 03월 01일 03:53:11
상세 보기
## 작업 계획\n- 실제 코드 파악 (doorkeeper, routes, controllers)\n- docs/api/consumer_integration_guide.md 작성\n- 한국어로 작성, 실제 응답 구조 반영