250 lines
171 KiB
HTML
250 lines
171 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="ko"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>API 설계 문서 작성법</title>
|
|
<style>
|
|
*{box-sizing:border-box;margin:0;padding:0}
|
|
html,body{background:#060d18;color:#F1F5F9;font-family:"Noto Sans KR","Noto Sans CJK KR","Apple SD Gothic Neo","Malgun Gothic",sans-serif}
|
|
.stage{width:1280px;transform-origin:0 0;margin:0 auto}
|
|
.slide{position:relative;width:1280px;height:720px;background:#0F1B2D;overflow:hidden;margin:0 0 24px}
|
|
.r,.t{position:absolute}
|
|
.t{display:flex;flex-direction:column;line-height:1.38;white-space:pre-wrap;word-break:keep-all;overflow-wrap:anywhere;font-weight:400}
|
|
.t.m{font-family:"D2Coding","Consolas","Menlo","DejaVu Sans Mono","Noto Sans KR","Noto Sans CJK KR",monospace;line-height:1.36;word-break:normal}
|
|
.t.ul .li{padding-left:1.2em;text-indent:-1.2em;margin-bottom:var(--gap,12px)}
|
|
.t.ul .li::before{content:"•";display:inline-block;width:1.2em;text-indent:0;color:#2DD4BF}
|
|
.bar{position:fixed;right:14px;bottom:10px;font-size:12px;color:#A8B8CC;background:rgba(6,13,24,.8);padding:4px 10px;border-radius:12px;z-index:9}
|
|
body.present{overflow:hidden}
|
|
body.present .slide{display:none;margin:0}
|
|
body.present .slide.on{display:block}
|
|
@page{size:1280px 720px;margin:0}
|
|
@media print{html,body{background:#0F1B2D}.bar{display:none}.stage{transform:none!important;margin:0!important}
|
|
.slide,body.present .slide{display:block;margin:0;break-after:page;break-inside:avoid}
|
|
*{-webkit-print-color-adjust:exact;print-color-adjust:exact}}
|
|
</style></head><body>
|
|
<main class="stage">
|
|
<section class="slide"><h1 class="t" style="left:57.599999999999994px;top:211.20000000000002px;width:1056px;height:115.19999999999999px;font-size:64px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>API 설계 문서 작성법</span></h1><div class="t" style="left:57.599999999999994px;top:336px;width:1056px;height:48px;font-size:29.333333333333332px;color:#2DD4BF;text-align:left;justify-content:center;"><span>최종 프로젝트 STEP 2 · REST API 및 Function Calling 명세서</span></div><div class="t" style="left:57.599999999999994px;top:398.40000000000003px;width:1056px;height:38.400000000000006px;font-size:20px;color:#A8B8CC;text-align:left;justify-content:center;"><span>AI 애플리케이션 개발 과정 · 최종 프로젝트 산출물 가이드</span></div><div class="r" style="left:57.599999999999994px;top:537.5999999999999px;width:285.888px;height:48px;background:#1A2B45;border-radius:24px"></div><div class="t m" style="left:57.599999999999994px;top:537.5999999999999px;width:285.888px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>GET /api/v1/incidents</span></div><div class="r" style="left:367.488px;top:537.5999999999999px;width:376.51199999999994px;height:48px;background:#1A2B45;border-radius:24px"></div><div class="t m" style="left:367.488px;top:537.5999999999999px;width:376.51199999999994px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>POST /incidents/{id}/recovery</span></div><div class="r" style="left:768px;top:537.5999999999999px;width:183.93599999999998px;height:48px;background:#1A2B45;border-radius:24px"></div><div class="t m" style="left:768px;top:537.5999999999999px;width:183.93599999999998px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>202 Accepted</span></div><div class="r" style="left:975.936px;top:537.5999999999999px;width:217.92000000000002px;height:48px;background:#1A2B45;border-radius:24px"></div><div class="t m" style="left:975.936px;top:537.5999999999999px;width:217.92000000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>restart_service</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>API 설계 문서는 팀의 계약서다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>2</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>코드를 쓰기 전에, 무엇을 주고받을지 합의해 두는 문서</span></div><div class="r" style="left:57.599999999999994px;top:206.39999999999998px;width:369.05600000000004px;height:316.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>프런트 ↔ 백엔드</span></div><div class="t" style="left:86.39999999999999px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>따로 개발해도 맞물린다</span></div><div class="t" style="left:86.39999999999999px;top:326.4px;width:311.456px;height:168px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>화면이 어떤 주소로 무엇을 보내고 무엇을 받는지 미리 정한다. 서로 기다리지 않고 동시에 개발할 수 있다.</span></div><div class="r" style="left:455.456px;top:206.39999999999998px;width:369.05600000000004px;height:316.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:484.256px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>에이전트 ↔ 도구</span></div><div class="t" style="left:484.256px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>Function Calling의 기준</span></div><div class="t" style="left:484.256px;top:326.4px;width:311.456px;height:168px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>LLM이 호출할 Tool의 이름, 입력, 실패 코드를 정한다. 에이전트 설계가 이 명세 위에 올라간다.</span></div><div class="r" style="left:853.3120000000001px;top:206.39999999999998px;width:369.05600000000004px;height:316.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:882.1120000000001px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>설계 ↔ 검증</span></div><div class="t" style="left:882.1120000000001px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>테스트의 근거</span></div><div class="t" style="left:882.1120000000001px;top:326.4px;width:311.456px;height:168px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>평가는 문서가 있는지가 아니라 설계·구현·검증이 이어지는지를 본다. 명세가 곧 테스트 케이스가 된다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>STEP 2에서 이 문서가 놓이는 자리</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>3</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>앞 단계의 요구사항을 받아, 뒤 단계의 구현과 검증에 기준을 넘겨준다</span></div><div class="r" style="left:57.599999999999994px;top:240px;width:200.69760000000002px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:72px;top:268.79999999999995px;width:171.8976px;height:48px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>기획서</span></div><div class="t" style="left:72px;top:331.20000000000005px;width:171.8976px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>기능 요구사항
|
|
FR-01 …</span></div><div class="t" style="left:258.29760000000005px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:298.61760000000004px;top:240px;width:200.69760000000002px;height:220.79999999999998px;background:#0F766E;border-radius:9.600000000000001px"></div><div class="t" style="left:313.0176px;top:268.79999999999995px;width:171.8976px;height:48px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>API 설계 문서</span></div><div class="t" style="left:313.0176px;top:331.20000000000005px;width:171.8976px;height:86.4px;font-size:18.666666666666668px;color:#F1F5F9;text-align:center;justify-content:flex-start;"><span>오늘 다루는
|
|
산출물</span></div><div class="t" style="left:499.3152px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:539.6351999999999px;top:240px;width:200.69760000000002px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:554.0352px;top:268.79999999999995px;width:171.8976px;height:48px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>DB 스키마 설계서</span></div><div class="t" style="left:554.0352px;top:331.20000000000005px;width:171.8976px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>STEP 2의
|
|
짝 산출물</span></div><div class="t" style="left:740.3328px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:780.6528000000001px;top:240px;width:200.69760000000002px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:795.0528px;top:268.79999999999995px;width:171.8976px;height:48px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>에이전트 설계</span></div><div class="t" style="left:795.0528px;top:331.20000000000005px;width:171.8976px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>Tool 정의를
|
|
가져다 쓴다</span></div><div class="t" style="left:981.3504px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:1021.6704px;top:240px;width:200.69760000000002px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:1036.0704px;top:268.79999999999995px;width:171.8976px;height:48px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>통합 테스트</span></div><div class="t" style="left:1036.0704px;top:331.20000000000005px;width:171.8976px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>명세대로
|
|
동작하는지 확인</span></div><div class="r" style="left:57.599999999999994px;top:513.5999999999999px;width:1164.768px;height:103.68px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:513.5999999999999px;width:1107.1680000000001px;height:103.68px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>API 설계 문서와 DB 스키마 설계서는 STEP 2의 필수 산출물이다.
|
|
두 문서는 같은 ID 형식을 쓰고, API 필드가 어느 DB 컬럼에 저장되는지 대응을 밝힌다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>문서에 들어가는 여섯 가지</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>4</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:369.05600000000004px;height:225.60000000000002px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:196.79999999999998px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>01</span></div><div class="t" style="left:86.39999999999999px;top:235.2px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>공통 정보와 인증</span></div><div class="t" style="left:86.39999999999999px;top:288px;width:311.456px;height:76.79999999999998px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>서버 주소, 인증, 오류 형식, /docs 위치, 변경 이력</span></div><div class="r" style="left:455.456px;top:168px;width:369.05600000000004px;height:225.60000000000002px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:484.256px;top:196.79999999999998px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>02</span></div><div class="t" style="left:484.256px;top:235.2px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>API 목록</span></div><div class="t" style="left:484.256px;top:288px;width:311.456px;height:76.79999999999998px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>메서드·경로·인증·설명을 한눈에 보는 표</span></div><div class="r" style="left:853.3120000000001px;top:168px;width:369.05600000000004px;height:225.60000000000002px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:882.1120000000001px;top:196.79999999999998px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>03</span></div><div class="t" style="left:882.1120000000001px;top:235.2px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>엔드포인트 상세 명세</span></div><div class="t" style="left:882.1120000000001px;top:288px;width:311.456px;height:76.79999999999998px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>필드 명세 표와 요청·응답·오류 예시</span></div><div class="r" style="left:57.599999999999994px;top:422.40000000000003px;width:369.05600000000004px;height:225.60000000000002px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:451.20000000000005px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>04</span></div><div class="t" style="left:86.39999999999999px;top:489.6px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>검증과 권한 규칙</span></div><div class="t" style="left:86.39999999999999px;top:542.4000000000001px;width:311.456px;height:76.79999999999998px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>입력 형식 검증과 서버의 권한·승인 검사</span></div><div class="r" style="left:455.456px;top:422.40000000000003px;width:369.05600000000004px;height:225.60000000000002px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:484.256px;top:451.20000000000005px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>05</span></div><div class="t" style="left:484.256px;top:489.6px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>Tool 정의와 호출 흐름</span></div><div class="t" style="left:484.256px;top:542.4000000000001px;width:311.456px;height:76.79999999999998px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>입력·출력·실패 처리·실행 조건과 순서</span></div><div class="r" style="left:853.3120000000001px;top:422.40000000000003px;width:369.05600000000004px;height:225.60000000000002px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:882.1120000000001px;top:451.20000000000005px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>06</span></div><div class="t" style="left:882.1120000000001px;top:489.6px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>실행 규칙</span></div><div class="t" style="left:882.1120000000001px;top:542.4000000000001px;width:311.456px;height:76.79999999999998px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>타임아웃, 재시도, 중복 실행 방지</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>REST는 자원을 주소로, 행위를 메서드로 나타낸다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>5</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>RESTful API는 이 약속을 지켜서 만든 API다. 주소만 봐도 무엇을 다루는지 알 수 있다</span></div><div class="r" style="left:57.599999999999994px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>자원 (Resource)</span></div><div class="t" style="left:86.39999999999999px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>다루는 대상에 주소를 준다</span></div><div class="t" style="left:86.39999999999999px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>장애, 복구 작업처럼 서비스가 다루는 대상 하나하나가 고유한 주소(URL)를 갖는다.</span></div><div class="r" style="left:86.39999999999999px;top:509.76px;width:311.456px;height:80.64000000000001px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:103.67999999999998px;top:509.76px;width:276.896px;height:80.64000000000001px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>/incidents
|
|
/incidents/inc-001</span></div><div class="r" style="left:455.456px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:484.256px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>행위 (Method)</span></div><div class="t" style="left:484.256px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>할 일은 메서드로 말한다</span></div><div class="t" style="left:484.256px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>같은 주소에 메서드만 바꿔 조회, 생성, 수정, 삭제를 구분한다.</span></div><div class="r" style="left:484.256px;top:509.76px;width:311.456px;height:80.64000000000001px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:501.53599999999994px;top:509.76px;width:276.896px;height:80.64000000000001px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET · POST
|
|
PATCH · DELETE</span></div><div class="r" style="left:853.3120000000001px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:882.1120000000001px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>표현 (Representation)</span></div><div class="t" style="left:882.1120000000001px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>내용은 JSON에 담는다</span></div><div class="t" style="left:882.1120000000001px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>자원의 현재 상태를 JSON 문서로 표현해 요청과 응답에 싣는다.</span></div><div class="r" style="left:882.1120000000001px;top:509.76px;width:311.456px;height:80.64000000000001px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:899.392px;top:509.76px;width:276.896px;height:80.64000000000001px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>{"id": "inc-001",
|
|
"status": "open"}</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>REST가 지키는 세 가지 원칙</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>6</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>원칙을 지키면 처음 보는 API도 예측할 수 있고, 서버를 여러 대로 늘리기 쉽다</span></div><div class="r" style="left:57.599999999999994px;top:206.39999999999998px;width:369.05600000000004px;height:316.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>원칙 1</span></div><div class="t" style="left:86.39999999999999px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>클라이언트와 서버의 분리</span></div><div class="t" style="left:86.39999999999999px;top:326.4px;width:311.456px;height:168px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>화면은 API 규격만 알면 된다. 서버 내부가 바뀌어도 규격이 같으면 화면은 그대로 동작한다.</span></div><div class="r" style="left:455.456px;top:206.39999999999998px;width:369.05600000000004px;height:316.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:484.256px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>원칙 2</span></div><div class="t" style="left:484.256px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>무상태 (Stateless)</span></div><div class="t" style="left:484.256px;top:326.4px;width:311.456px;height:168px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>서버는 앞선 요청을 기억하지 않는다. 그래서 요청마다 토큰과 필요한 ID를 모두 실어 보낸다.</span></div><div class="r" style="left:853.3120000000001px;top:206.39999999999998px;width:369.05600000000004px;height:316.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:882.1120000000001px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>원칙 3</span></div><div class="t" style="left:882.1120000000001px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>일관된 인터페이스</span></div><div class="t" style="left:882.1120000000001px;top:326.4px;width:311.456px;height:168px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>모든 자원에 같은 주소 규칙, 같은 메서드 의미, 같은 오류 형식을 쓴다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>HTTP 요청과 응답은 세 부분으로 읽는다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>7</span></div><div class="t ul" style="left:57.599999999999994px;top:172.8px;width:412.79999999999995px;height:441.59999999999997px;font-size:21.333333333333332px;color:#CBD5E1;text-align:left;justify-content:flex-start;--gap:18.666666666666668px;"><div class="li">시작줄: 요청은 메서드와 경로, 응답은 상태 코드</div><div class="li">헤더: 인증 토큰, 본문 형식 같은 부가 정보</div><div class="li">본문: 주고받는 데이터(JSON). GET 요청에는 보통 본문이 없다.</div><div class="li">API 설계 문서는 이 세 부분을 엔드포인트마다 적는 것이다.</div></div><div class="r" style="left:508.79999999999995px;top:168px;width:713.5680000000001px;height:401.28px;background:#0A1322;border-radius:9.600000000000001px"></div><div class="t m" style="left:537.5999999999999px;top:179.52px;width:655.9680000000001px;height:28.799999999999997px;font-size:16px;color:#A8B8CC;text-align:left;justify-content:center;"><span>요청과 응답의 구조</span></div><div class="t m" style="left:537.5999999999999px;top:216px;width:655.9680000000001px;height:343.67999999999995px;font-size:17.333333333333332px;color:#F1F5F9;text-align:left;justify-content:flex-start;"><span># 요청 ① 시작줄
|
|
POST /api/v1/incidents/inc-001/recovery HTTP/1.1
|
|
# 요청 ② 헤더
|
|
Authorization: Bearer <JWT>
|
|
Content-Type: application/json
|
|
# 요청 ③ 본문
|
|
{"action": "restart", "approval_id": "apr-001"}
|
|
|
|
# 응답 ① 시작줄
|
|
HTTP/1.1 202 Accepted
|
|
# 응답 ② 헤더
|
|
Content-Type: application/json
|
|
# 응답 ③ 본문
|
|
{"job_id": "job-001", "status": "queued"}</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>메서드마다 의미와 성질이 정해져 있다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>8</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:1164.768px;height:48px;background:#22375A;border-radius:0px"></div><div class="t" style="left:78.72px;top:168px;width:120.82752000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>메서드</span></div><div class="t" style="left:241.78752000000003px;top:168px;width:260.59968000000003px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>하는 일</span></div><div class="t" style="left:544.6272px;top:168px;width:167.41824000000003px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>안전 (조회만)</span></div><div class="t" style="left:754.28544px;top:168px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>멱등</span></div><div class="t" style="left:987.2390400000002px;top:168px;width:214.00896000000006px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>성공 코드</span></div><div class="r" style="left:57.599999999999994px;top:216px;width:1164.768px;height:48px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:216px;width:120.82752000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET</span></div><div class="t" style="left:241.78752000000003px;top:216px;width:260.59968000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>조회</span></div><div class="t" style="left:544.6272px;top:216px;width:167.41824000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>예</span></div><div class="t" style="left:754.28544px;top:216px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>예</span></div><div class="t" style="left:987.2390400000002px;top:216px;width:214.00896000000006px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>200</span></div><div class="r" style="left:57.599999999999994px;top:264px;width:1164.768px;height:48px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:264px;width:120.82752000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>POST</span></div><div class="t" style="left:241.78752000000003px;top:264px;width:260.59968000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>생성, 실행 요청</span></div><div class="t" style="left:544.6272px;top:264px;width:167.41824000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>아니오</span></div><div class="t" style="left:754.28544px;top:264px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>아니오</span></div><div class="t" style="left:987.2390400000002px;top:264px;width:214.00896000000006px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>201 / 202</span></div><div class="r" style="left:57.599999999999994px;top:312px;width:1164.768px;height:48px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:312px;width:120.82752000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>PUT</span></div><div class="t" style="left:241.78752000000003px;top:312px;width:260.59968000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>전체 교체</span></div><div class="t" style="left:544.6272px;top:312px;width:167.41824000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>아니오</span></div><div class="t" style="left:754.28544px;top:312px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>예</span></div><div class="t" style="left:987.2390400000002px;top:312px;width:214.00896000000006px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>200</span></div><div class="r" style="left:57.599999999999994px;top:360px;width:1164.768px;height:48px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:360px;width:120.82752000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>PATCH</span></div><div class="t" style="left:241.78752000000003px;top:360px;width:260.59968000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>일부 수정</span></div><div class="t" style="left:544.6272px;top:360px;width:167.41824000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>아니오</span></div><div class="t" style="left:754.28544px;top:360px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>보장되지 않음</span></div><div class="t" style="left:987.2390400000002px;top:360px;width:214.00896000000006px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>200</span></div><div class="r" style="left:57.599999999999994px;top:408px;width:1164.768px;height:48px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:408px;width:120.82752000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>DELETE</span></div><div class="t" style="left:241.78752000000003px;top:408px;width:260.59968000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>삭제</span></div><div class="t" style="left:544.6272px;top:408px;width:167.41824000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>아니오</span></div><div class="t" style="left:754.28544px;top:408px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>예</span></div><div class="t" style="left:987.2390400000002px;top:408px;width:214.00896000000006px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>204</span></div><div class="r" style="left:57.599999999999994px;top:484.79999999999995px;width:1164.768px;height:103.68px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:484.79999999999995px;width:1107.1680000000001px;height:103.68px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>멱등은 같은 요청을 여러 번 보내도 결과가 한 번 보낸 것과 같다는 뜻이다.
|
|
POST는 멱등이 아니므로, 복구 요청이 두 번 들어와도 한 번만 실행되게 하는 장치(중복 방지 키, 409 응답)를 설계에 넣는다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>상태 코드는 첫 자리로 읽는다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>9</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>누구 쪽 문제인지가 첫 자리에 담겨 있다. 무조건 200으로 응답하고 본문에 오류를 넣지 않는다</span></div><div class="r" style="left:57.599999999999994px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>2xx</span></div><div class="t" style="left:86.39999999999999px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>성공</span></div><div class="t" style="left:86.39999999999999px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>요청을 정상 처리했다. 조회, 생성, 접수, 삭제에 따라 코드를 구분한다.</span></div><div class="r" style="left:86.39999999999999px;top:457.91999999999996px;width:311.456px;height:132.48000000000002px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:103.67999999999998px;top:457.91999999999996px;width:276.896px;height:132.48000000000002px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>200 OK
|
|
201 Created
|
|
202 Accepted
|
|
204 No Content</span></div><div class="r" style="left:455.456px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:484.256px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>4xx</span></div><div class="t" style="left:484.256px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>요청 쪽 문제</span></div><div class="t" style="left:484.256px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>보낸 쪽이 고쳐야 한다. 값, 인증, 권한, 대상, 충돌 중 무엇이 문제인지 알려준다.</span></div><div class="r" style="left:484.256px;top:483.8399999999999px;width:311.456px;height:106.56px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:501.53599999999994px;top:483.8399999999999px;width:276.896px;height:106.56px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>400 · 422 잘못된 값
|
|
401 인증 · 403 권한
|
|
404 없음 · 409 충돌</span></div><div class="r" style="left:853.3120000000001px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:882.1120000000001px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>5xx</span></div><div class="t" style="left:882.1120000000001px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>서버 쪽 문제</span></div><div class="t" style="left:882.1120000000001px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>서버가 고쳐야 한다. 내부 오류 내용은 응답에 노출하지 않고 로그에 남긴다.</span></div><div class="r" style="left:882.1120000000001px;top:509.76px;width:311.456px;height:80.64000000000001px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:899.392px;top:509.76px;width:276.896px;height:80.64000000000001px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>500 Internal Server Error
|
|
503 Service Unavailable</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>주소 규칙: RESTful하지 않은 주소를 고쳐 쓴다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>10</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:1164.768px;height:48px;background:#22375A;border-radius:0px"></div><div class="t" style="left:78.72px;top:168px;width:330.48576px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>이렇게 쓰지 않는다</span></div><div class="t" style="left:451.44576px;top:168px;width:307.1904px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>이렇게 쓴다</span></div><div class="t" style="left:800.87616px;top:168px;width:400.37184px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>규칙</span></div><div class="r" style="left:57.599999999999994px;top:216px;width:1164.768px;height:48px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:216px;width:330.48576px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET /getIncidents</span></div><div class="t m" style="left:451.44576px;top:216px;width:307.1904px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET /incidents</span></div><div class="t" style="left:800.87616px;top:216px;width:400.37184px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>주소는 복수형 명사, 동사는 메서드가 말한다</span></div><div class="r" style="left:57.599999999999994px;top:264px;width:1164.768px;height:48px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:264px;width:330.48576px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>POST /deleteIncident?id=1</span></div><div class="t m" style="left:451.44576px;top:264px;width:307.1904px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>DELETE /incidents/1</span></div><div class="t" style="left:800.87616px;top:264px;width:400.37184px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>대상은 경로에, 행위는 메서드에 둔다</span></div><div class="r" style="left:57.599999999999994px;top:312px;width:1164.768px;height:48px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:312px;width:330.48576px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET /incidents/1/delete</span></div><div class="t m" style="left:451.44576px;top:312px;width:307.1904px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>DELETE /incidents/1</span></div><div class="t" style="left:800.87616px;top:312px;width:400.37184px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>GET은 조회만 한다. 데이터를 바꾸지 않는다</span></div><div class="r" style="left:57.599999999999994px;top:360px;width:1164.768px;height:48px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:360px;width:330.48576px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>/Recovery_Jobs</span></div><div class="t m" style="left:451.44576px;top:360px;width:307.1904px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>/recovery-jobs</span></div><div class="t" style="left:800.87616px;top:360px;width:400.37184px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>소문자와 하이픈으로 통일한다</span></div><div class="r" style="left:57.599999999999994px;top:408px;width:1164.768px;height:48px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:408px;width:330.48576px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>/incidents</span></div><div class="t m" style="left:451.44576px;top:408px;width:307.1904px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>/api/v1/incidents</span></div><div class="t" style="left:800.87616px;top:408px;width:400.37184px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>버전을 붙여 규격이 바뀌어도 화면이 안 깨지게</span></div><div class="r" style="left:57.599999999999994px;top:456px;width:1164.768px;height:48px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:456px;width:330.48576px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>POST /recovery?incident=1</span></div><div class="t m" style="left:451.44576px;top:456px;width:307.1904px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>POST /incidents/1/recovery</span></div><div class="t" style="left:800.87616px;top:456px;width:400.37184px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>특정 대상에 딸린 행위는 그 대상 아래에</span></div><div class="r" style="left:57.599999999999994px;top:532.8px;width:1164.768px;height:103.68px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:532.8px;width:1107.1680000000001px;height:103.68px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>진단·복구처럼 '실행'하는 행위는 명사로 떨어지지 않는다.
|
|
이때는 POST와 하위 경로(/incidents/{id}/diagnose)로 표현하는 것이 실무 관례다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>목록 조회는 필터·정렬·페이지를 쿼리로 받는다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>11</span></div><div class="t ul" style="left:57.599999999999994px;top:172.8px;width:412.79999999999995px;height:441.59999999999997px;font-size:21.333333333333332px;color:#CBD5E1;text-align:left;justify-content:flex-start;--gap:18.666666666666668px;"><div class="li">경로는 자원을 가리키고, 조건은 ? 뒤 쿼리 파라미터로 붙인다.</div><div class="li">요구사항 FR-01의 "상태·발생시간·자산명으로 필터링"이 곧 쿼리 파라미터 목록이다.</div><div class="li">응답에는 목록과 함께 전체 건수, 현재 페이지를 담는다.</div><div class="li">파라미터 이름과 기본값은 팀에서 정해 문서에 적는다.</div></div><div class="r" style="left:508.79999999999995px;top:168px;width:713.5680000000001px;height:401.28px;background:#0A1322;border-radius:9.600000000000001px"></div><div class="t m" style="left:537.5999999999999px;top:179.52px;width:655.9680000000001px;height:28.799999999999997px;font-size:16px;color:#A8B8CC;text-align:left;justify-content:center;"><span>GET /api/v1/incidents (형식 예시)</span></div><div class="t m" style="left:537.5999999999999px;top:216px;width:655.9680000000001px;height:343.67999999999995px;font-size:17.333333333333332px;color:#F1F5F9;text-align:left;justify-content:flex-start;"><span>GET /api/v1/incidents?status=open&asset=svc-api-01
|
|
&sort=-created_at&page=1&size=20
|
|
Authorization: Bearer <JWT>
|
|
|
|
HTTP/1.1 200 OK
|
|
{
|
|
"items": [
|
|
{"id": "inc-001", "status": "open",
|
|
"asset": "svc-api-01"}
|
|
],
|
|
"total": 37,
|
|
"page": 1,
|
|
"size": 20
|
|
}</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>요구사항에서 API를 뽑아낸다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>12</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>요구사항 한 줄마다 "무엇을, 어떻게 하는가"를 물으면 엔드포인트가 나온다</span></div><div class="r" style="left:57.599999999999994px;top:206.39999999999998px;width:1164.768px;height:48px;background:#22375A;border-radius:0px"></div><div class="t" style="left:78.72px;top:206.39999999999998px;width:237.30432000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>요구사항</span></div><div class="t" style="left:358.26432000000005px;top:206.39999999999998px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>다루는 대상</span></div><div class="t" style="left:591.21792px;top:206.39999999999998px;width:109.17984000000001px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>행위</span></div><div class="t" style="left:742.63776px;top:206.39999999999998px;width:458.61024px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>엔드포인트</span></div><div class="r" style="left:57.599999999999994px;top:254.39999999999998px;width:1164.768px;height:59.519999999999996px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:254.39999999999998px;width:237.30432000000002px;height:59.519999999999996px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>FR-01 장애 목록 조회</span></div><div class="t" style="left:358.26432000000005px;top:254.39999999999998px;width:190.71360000000004px;height:59.519999999999996px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>incidents</span></div><div class="t" style="left:591.21792px;top:254.39999999999998px;width:109.17984000000001px;height:59.519999999999996px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>조회</span></div><div class="t m" style="left:742.63776px;top:254.39999999999998px;width:458.61024px;height:59.519999999999996px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET /api/v1/incidents</span></div><div class="r" style="left:57.599999999999994px;top:313.92px;width:1164.768px;height:59.519999999999996px;background:#15233A;border-radius:0px"></div><div class="t" style="left:78.72px;top:313.92px;width:237.30432000000002px;height:59.519999999999996px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>FR-02 AI 원인 진단</span></div><div class="t" style="left:358.26432000000005px;top:313.92px;width:190.71360000000004px;height:59.519999999999996px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>incidents의 진단</span></div><div class="t" style="left:591.21792px;top:313.92px;width:109.17984000000001px;height:59.519999999999996px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>실행 요청</span></div><div class="t m" style="left:742.63776px;top:313.92px;width:458.61024px;height:59.519999999999996px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>POST /api/v1/incidents/{id}/diagnose</span></div><div class="r" style="left:57.599999999999994px;top:373.44px;width:1164.768px;height:59.519999999999996px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:373.44px;width:237.30432000000002px;height:59.519999999999996px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>FR-03 복구 작업 승인</span></div><div class="t" style="left:358.26432000000005px;top:373.44px;width:190.71360000000004px;height:59.519999999999996px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>incidents의 복구</span></div><div class="t" style="left:591.21792px;top:373.44px;width:109.17984000000001px;height:59.519999999999996px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>실행 요청</span></div><div class="t m" style="left:742.63776px;top:373.44px;width:458.61024px;height:59.519999999999996px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>POST /api/v1/incidents/{id}/recovery</span></div><div class="r" style="left:57.599999999999994px;top:432.96px;width:1164.768px;height:59.519999999999996px;background:#15233A;border-radius:0px"></div><div class="t" style="left:78.72px;top:432.96px;width:237.30432000000002px;height:59.519999999999996px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>FR-04 복구 이력 조회</span></div><div class="t" style="left:358.26432000000005px;top:432.96px;width:190.71360000000004px;height:59.519999999999996px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>recovery-jobs</span></div><div class="t" style="left:591.21792px;top:432.96px;width:109.17984000000001px;height:59.519999999999996px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>조회</span></div><div class="t m" style="left:742.63776px;top:432.96px;width:458.61024px;height:59.519999999999996px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET /api/v1/recovery-jobs/{id}</span></div><div class="r" style="left:57.599999999999994px;top:521.28px;width:1164.768px;height:71.03999999999999px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:521.28px;width:1107.1680000000001px;height:71.03999999999999px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>예시는 산출물 샘플(InfraCare AI, 교육용 가상 서비스) 기준이다. 팀 주제의 대상과 행위로 바꿔 쓴다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>문서 머리말에 공통 정보를 모은다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>13</span></div><div class="t ul" style="left:57.599999999999994px;top:172.8px;width:412.79999999999995px;height:441.59999999999997px;font-size:21.333333333333332px;color:#CBD5E1;text-align:left;justify-content:flex-start;--gap:18.666666666666668px;"><div class="li">개발 서버와 배포 서버의 기본 주소를 적는다.</div><div class="li">FastAPI가 만드는 자동 문서(/docs)의 위치를 적고, 문서와 대조한다.</div><div class="li">오류 응답은 모든 API가 같은 형식을 쓴다.</div><div class="li">바뀔 때마다 버전을 올리고 변경 이력에 남긴다.</div></div><div class="r" style="left:508.79999999999995px;top:168px;width:713.5680000000001px;height:471.84000000000003px;background:#0A1322;border-radius:9.600000000000001px"></div><div class="t m" style="left:537.5999999999999px;top:179.52px;width:655.9680000000001px;height:28.799999999999997px;font-size:16px;color:#A8B8CC;text-align:left;justify-content:center;"><span>API 설계 문서 머리말 (형식 예시)</span></div><div class="t m" style="left:537.5999999999999px;top:216px;width:655.9680000000001px;height:414.24px;font-size:17.333333333333332px;color:#F1F5F9;text-align:left;justify-content:flex-start;"><span># API 설계 문서 — <서비스명>
|
|
문서 버전 v0.2 | 작성 상태: 검토 중
|
|
|
|
## 공통 정보
|
|
- 개발 서버: http://localhost:8000/api/v1
|
|
- 배포 서버: https://<배포 도메인>/api/v1
|
|
- 자동 문서: <서버 주소>/docs, /openapi.json
|
|
- 인증: Authorization: Bearer <JWT>
|
|
|
|
## 공통 오류 형식
|
|
{"error": {"code": "APPROVAL_REQUIRED",
|
|
"message": "승인이 필요합니다",
|
|
"request_id": "req-001"}}
|
|
|
|
## 변경 이력
|
|
| v0.1 | 11/18 | 초안 작성 | 백엔드 담당 |
|
|
| v0.2 | 11/20 | 409 응답 추가 | 백엔드 담당 |</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>인증 방식은 네 줄로 적는다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>14</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:1164.768px;height:48px;background:#22375A;border-radius:0px"></div><div class="t" style="left:78.72px;top:168px;width:97.53216000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>항목</span></div><div class="t" style="left:218.49216000000004px;top:168px;width:342.13344px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>적을 내용</span></div><div class="t" style="left:602.8656000000001px;top:168px;width:598.3824000000001px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>예시</span></div><div class="r" style="left:57.599999999999994px;top:216px;width:1164.768px;height:76.80000000000001px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:216px;width:97.53216000000002px;height:76.80000000000001px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>인증</span></div><div class="t" style="left:218.49216000000004px;top:216px;width:342.13344px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>토큰을 어디서 발급받는가</span></div><div class="t" style="left:602.8656000000001px;top:216px;width:598.3824000000001px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>Supabase Auth 로그인 → JWT Access Token 발급</span></div><div class="r" style="left:57.599999999999994px;top:292.79999999999995px;width:1164.768px;height:76.80000000000001px;background:#15233A;border-radius:0px"></div><div class="t" style="left:78.72px;top:292.79999999999995px;width:97.53216000000002px;height:76.80000000000001px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>전달</span></div><div class="t" style="left:218.49216000000004px;top:292.79999999999995px;width:342.13344px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>요청에 토큰을 어떻게 싣는가</span></div><div class="t" style="left:602.8656000000001px;top:292.79999999999995px;width:598.3824000000001px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>Authorization: Bearer <access_token></span></div><div class="r" style="left:57.599999999999994px;top:369.59999999999997px;width:1164.768px;height:76.80000000000001px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:369.59999999999997px;width:97.53216000000002px;height:76.80000000000001px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>검증</span></div><div class="t" style="left:218.49216000000004px;top:369.59999999999997px;width:342.13344px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>서버가 무엇을 확인하는가</span></div><div class="t" style="left:602.8656000000001px;top:369.59999999999997px;width:598.3824000000001px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>서명·만료·역할 (복구 실행은 operator/admin만 허용)</span></div><div class="r" style="left:57.599999999999994px;top:446.4px;width:1164.768px;height:76.80000000000001px;background:#15233A;border-radius:0px"></div><div class="t" style="left:78.72px;top:446.4px;width:97.53216000000002px;height:76.80000000000001px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>오류</span></div><div class="t" style="left:218.49216000000004px;top:446.4px;width:342.13344px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>실패하면 무엇을 돌려주는가</span></div><div class="t" style="left:602.8656000000001px;top:446.4px;width:598.3824000000001px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>401 토큰 누락·만료 / 403 권한 부족</span></div><div class="r" style="left:57.599999999999994px;top:551.9999999999999px;width:1164.768px;height:71.03999999999999px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:551.9999999999999px;width:1107.1680000000001px;height:71.03999999999999px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>401은 "누구인지 모른다", 403은 "누구인지는 알지만 권한이 없다"는 뜻이다. 둘을 구분해서 적는다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>API 목록 표로 전체를 한 장에 담는다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>15</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:1164.768px;height:48px;background:#22375A;border-radius:0px"></div><div class="t" style="left:78.72px;top:168px;width:74.23680000000003px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>메서드</span></div><div class="t" style="left:195.19680000000005px;top:168px;width:388.72416px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>경로</span></div><div class="t" style="left:626.1609599999999px;top:168px;width:132.4752px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>인증</span></div><div class="t" style="left:800.87616px;top:168px;width:214.00896000000006px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>설명</span></div><div class="t" style="left:1057.1251200000002px;top:168px;width:144.12288px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>관련 요구사항</span></div><div class="r" style="left:57.599999999999994px;top:216px;width:1164.768px;height:76.80000000000001px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:216px;width:74.23680000000003px;height:76.80000000000001px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET</span></div><div class="t m" style="left:195.19680000000005px;top:216px;width:388.72416px;height:76.80000000000001px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>/api/v1/incidents</span></div><div class="t" style="left:626.1609599999999px;top:216px;width:132.4752px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>JWT</span></div><div class="t" style="left:800.87616px;top:216px;width:214.00896000000006px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>장애 목록 조회</span></div><div class="t" style="left:1057.1251200000002px;top:216px;width:144.12288px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>FR-01</span></div><div class="r" style="left:57.599999999999994px;top:292.79999999999995px;width:1164.768px;height:76.80000000000001px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:292.79999999999995px;width:74.23680000000003px;height:76.80000000000001px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>POST</span></div><div class="t m" style="left:195.19680000000005px;top:292.79999999999995px;width:388.72416px;height:76.80000000000001px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>/api/v1/incidents/{id}/diagnose</span></div><div class="t" style="left:626.1609599999999px;top:292.79999999999995px;width:132.4752px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>JWT</span></div><div class="t" style="left:800.87616px;top:292.79999999999995px;width:214.00896000000006px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>AI 진단 실행</span></div><div class="t" style="left:1057.1251200000002px;top:292.79999999999995px;width:144.12288px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>FR-02</span></div><div class="r" style="left:57.599999999999994px;top:369.59999999999997px;width:1164.768px;height:76.80000000000001px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:369.59999999999997px;width:74.23680000000003px;height:76.80000000000001px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>POST</span></div><div class="t m" style="left:195.19680000000005px;top:369.59999999999997px;width:388.72416px;height:76.80000000000001px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>/api/v1/incidents/{id}/recovery</span></div><div class="t" style="left:626.1609599999999px;top:369.59999999999997px;width:132.4752px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>JWT + 운영자</span></div><div class="t" style="left:800.87616px;top:369.59999999999997px;width:214.00896000000006px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>복구 작업 요청</span></div><div class="t" style="left:1057.1251200000002px;top:369.59999999999997px;width:144.12288px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>FR-03</span></div><div class="r" style="left:57.599999999999994px;top:446.4px;width:1164.768px;height:76.80000000000001px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:446.4px;width:74.23680000000003px;height:76.80000000000001px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET</span></div><div class="t m" style="left:195.19680000000005px;top:446.4px;width:388.72416px;height:76.80000000000001px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>/api/v1/recovery-jobs/{id}</span></div><div class="t" style="left:626.1609599999999px;top:446.4px;width:132.4752px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>JWT</span></div><div class="t" style="left:800.87616px;top:446.4px;width:214.00896000000006px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>복구 작업 상태 조회</span></div><div class="t" style="left:1057.1251200000002px;top:446.4px;width:144.12288px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>FR-04</span></div><div class="r" style="left:57.599999999999994px;top:551.9999999999999px;width:1164.768px;height:103.68px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:551.9999999999999px;width:1107.1680000000001px;height:103.68px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>'관련 요구사항' 열로 기획서와의 연결을 보인다. 요구사항에 필요한 API만 적는다.
|
|
모든 자원의 CRUD 전체, 작업 큐, SSE는 팀이 실제로 쓰는 경우에만 넣는다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>상세 명세는 여덟 칸을 채운다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>16</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>구현할 API마다 표 하나. 오늘은 핵심 1개로 초안을 쓰고, 최종 제출에는 전체를 채운다</span></div><div class="r" style="left:57.599999999999994px;top:206.39999999999998px;width:269.592px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:235.2px;width:211.99200000000002px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>1</span></div><div class="t" style="left:86.39999999999999px;top:273.59999999999997px;width:211.99200000000002px;height:40.32px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>호출 목적</span></div><div class="t" style="left:86.39999999999999px;top:326.4px;width:211.99200000000002px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>누가, 언제, 왜 부르는가</span></div><div class="r" style="left:355.992px;top:206.39999999999998px;width:269.592px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:384.79200000000003px;top:235.2px;width:211.99200000000002px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>2</span></div><div class="t" style="left:384.79200000000003px;top:273.59999999999997px;width:211.99200000000002px;height:40.32px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>요청 헤더</span></div><div class="t" style="left:384.79200000000003px;top:326.4px;width:211.99200000000002px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>Authorization, X-Request-ID 등</span></div><div class="r" style="left:654.384px;top:206.39999999999998px;width:269.592px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:683.184px;top:235.2px;width:211.99200000000002px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>3</span></div><div class="t" style="left:683.184px;top:273.59999999999997px;width:211.99200000000002px;height:40.32px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>경로·쿼리</span></div><div class="t" style="left:683.184px;top:326.4px;width:211.99200000000002px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>이름, 타입, 필수 여부, 기본값</span></div><div class="r" style="left:952.776px;top:206.39999999999998px;width:269.592px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:981.576px;top:235.2px;width:211.99200000000002px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>4</span></div><div class="t" style="left:981.576px;top:273.59999999999997px;width:211.99200000000002px;height:40.32px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>요청 본문</span></div><div class="t" style="left:981.576px;top:326.4px;width:211.99200000000002px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>필드 명세 표와 실제 값의 JSON</span></div><div class="r" style="left:57.599999999999994px;top:441.59999999999997px;width:269.592px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:470.4px;width:211.99200000000002px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>5</span></div><div class="t" style="left:86.39999999999999px;top:508.79999999999995px;width:211.99200000000002px;height:40.32px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>검증·권한</span></div><div class="t" style="left:86.39999999999999px;top:561.5999999999999px;width:211.99200000000002px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>형식 검증과 권한·승인 조건</span></div><div class="r" style="left:355.992px;top:441.59999999999997px;width:269.592px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:384.79200000000003px;top:470.4px;width:211.99200000000002px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>6</span></div><div class="t" style="left:384.79200000000003px;top:508.79999999999995px;width:211.99200000000002px;height:40.32px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>정상 응답</span></div><div class="t" style="left:384.79200000000003px;top:561.5999999999999px;width:211.99200000000002px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>상태 코드, 필드 명세, 예시 JSON</span></div><div class="r" style="left:654.384px;top:441.59999999999997px;width:269.592px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:683.184px;top:470.4px;width:211.99200000000002px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>7</span></div><div class="t" style="left:683.184px;top:508.79999999999995px;width:211.99200000000002px;height:40.32px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>오류 응답</span></div><div class="t" style="left:683.184px;top:561.5999999999999px;width:211.99200000000002px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>상태 코드별 발생 조건과 오류 코드</span></div><div class="r" style="left:952.776px;top:441.59999999999997px;width:269.592px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:981.576px;top:470.4px;width:211.99200000000002px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>8</span></div><div class="t" style="left:981.576px;top:508.79999999999995px;width:211.99200000000002px;height:40.32px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>실행 규칙</span></div><div class="t" style="left:981.576px;top:561.5999999999999px;width:211.99200000000002px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>타임아웃, 재시도, 중복 방지</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>예시: 복구 요청 API의 요청과 응답</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>17</span></div><div class="t ul" style="left:57.599999999999994px;top:172.8px;width:412.79999999999995px;height:441.59999999999997px;font-size:21.333333333333332px;color:#CBD5E1;text-align:left;justify-content:flex-start;--gap:18.666666666666668px;"><div class="li">202는 "접수했지만 처리는 끝나지 않았다"는 뜻이다. 실행이 시작됐거나 성공했다는 보장은 아니다.</div><div class="li">결과는 job_id로 따로 조회해야 안다.</div><div class="li">예시값은 다른 산출물과 같은 ID를 쓴다. (inc-001, apr-001, req-001)</div></div><div class="r" style="left:508.79999999999995px;top:168px;width:713.5680000000001px;height:471.84000000000003px;background:#0A1322;border-radius:9.600000000000001px"></div><div class="t m" style="left:537.5999999999999px;top:179.52px;width:655.9680000000001px;height:28.799999999999997px;font-size:16px;color:#A8B8CC;text-align:left;justify-content:center;"><span>POST /api/v1/incidents/{incident_id}/recovery</span></div><div class="t m" style="left:537.5999999999999px;top:216px;width:655.9680000000001px;height:414.24px;font-size:17.333333333333332px;color:#F1F5F9;text-align:left;justify-content:flex-start;"><span>POST /api/v1/incidents/inc-001/recovery
|
|
Authorization: Bearer <JWT>
|
|
Content-Type: application/json
|
|
X-Request-ID: req-001
|
|
|
|
{
|
|
"action": "restart",
|
|
"target_id": "svc-api-01",
|
|
"approval_id": "apr-001"
|
|
}
|
|
|
|
HTTP 202
|
|
{
|
|
"job_id": "job-001",
|
|
"status": "queued",
|
|
"incident_id": "inc-001"
|
|
}</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>JSON 예시 옆에 필드 명세 표를 둔다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>18</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:1164.768px;height:48px;background:#22375A;border-radius:0px"></div><div class="t" style="left:78.72px;top:168px;width:132.4752px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>필드</span></div><div class="t" style="left:253.4352px;top:168px;width:39.29376000000001px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>위치</span></div><div class="t" style="left:334.96896000000004px;top:168px;width:85.88448000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>타입</span></div><div class="t" style="left:463.09344px;top:168px;width:109.17984000000001px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>필수</span></div><div class="t" style="left:614.5132799999999px;top:168px;width:39.29376000000001px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>빈값</span></div><div class="t" style="left:696.0470399999999px;top:168px;width:237.30432000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>제약</span></div><div class="t" style="left:975.5913599999999px;top:168px;width:225.65664000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>설명</span></div><div class="r" style="left:57.599999999999994px;top:216px;width:1164.768px;height:44.160000000000004px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:216px;width:132.4752px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>incident_id</span></div><div class="t" style="left:253.4352px;top:216px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>경로</span></div><div class="t m" style="left:334.96896000000004px;top:216px;width:85.88448000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>string</span></div><div class="t" style="left:463.09344px;top:216px;width:109.17984000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>필수</span></div><div class="t" style="left:614.5132799999999px;top:216px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>불가</span></div><div class="t" style="left:696.0470399999999px;top:216px;width:237.30432000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>inc-로 시작</span></div><div class="t" style="left:975.5913599999999px;top:216px;width:225.65664000000004px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>대상 장애</span></div><div class="r" style="left:57.599999999999994px;top:260.15999999999997px;width:1164.768px;height:44.160000000000004px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:260.15999999999997px;width:132.4752px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>dry_run</span></div><div class="t" style="left:253.4352px;top:260.15999999999997px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>쿼리</span></div><div class="t m" style="left:334.96896000000004px;top:260.15999999999997px;width:85.88448000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>bool</span></div><div class="t" style="left:463.09344px;top:260.15999999999997px;width:109.17984000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>선택</span></div><div class="t" style="left:614.5132799999999px;top:260.15999999999997px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>-</span></div><div class="t" style="left:696.0470399999999px;top:260.15999999999997px;width:237.30432000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>기본 false</span></div><div class="t" style="left:975.5913599999999px;top:260.15999999999997px;width:225.65664000000004px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>모의 실행 여부</span></div><div class="r" style="left:57.599999999999994px;top:304.32px;width:1164.768px;height:44.160000000000004px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:304.32px;width:132.4752px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>action</span></div><div class="t" style="left:253.4352px;top:304.32px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>본문</span></div><div class="t m" style="left:334.96896000000004px;top:304.32px;width:85.88448000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>string</span></div><div class="t" style="left:463.09344px;top:304.32px;width:109.17984000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>필수</span></div><div class="t" style="left:614.5132799999999px;top:304.32px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>불가</span></div><div class="t" style="left:696.0470399999999px;top:304.32px;width:237.30432000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>restart, reconnect, fallback</span></div><div class="t" style="left:975.5913599999999px;top:304.32px;width:225.65664000000004px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>복구 방식</span></div><div class="r" style="left:57.599999999999994px;top:348.48px;width:1164.768px;height:44.160000000000004px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:348.48px;width:132.4752px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>target_id</span></div><div class="t" style="left:253.4352px;top:348.48px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>본문</span></div><div class="t m" style="left:334.96896000000004px;top:348.48px;width:85.88448000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>string</span></div><div class="t" style="left:463.09344px;top:348.48px;width:109.17984000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>필수</span></div><div class="t" style="left:614.5132799999999px;top:348.48px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>불가</span></div><div class="t" style="left:696.0470399999999px;top:348.48px;width:237.30432000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>1~64자</span></div><div class="t" style="left:975.5913599999999px;top:348.48px;width:225.65664000000004px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>대상 서비스</span></div><div class="r" style="left:57.599999999999994px;top:392.64px;width:1164.768px;height:44.160000000000004px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:392.64px;width:132.4752px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>approval_id</span></div><div class="t" style="left:253.4352px;top:392.64px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>본문</span></div><div class="t m" style="left:334.96896000000004px;top:392.64px;width:85.88448000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>string</span></div><div class="t" style="left:463.09344px;top:392.64px;width:109.17984000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>restart면 필수</span></div><div class="t" style="left:614.5132799999999px;top:392.64px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>불가</span></div><div class="t" style="left:696.0470399999999px;top:392.64px;width:237.30432000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>승인된 ID</span></div><div class="t" style="left:975.5913599999999px;top:392.64px;width:225.65664000000004px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>운영자 승인</span></div><div class="r" style="left:57.599999999999994px;top:436.79999999999995px;width:1164.768px;height:44.160000000000004px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:436.79999999999995px;width:132.4752px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>job_id</span></div><div class="t" style="left:253.4352px;top:436.79999999999995px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>응답</span></div><div class="t m" style="left:334.96896000000004px;top:436.79999999999995px;width:85.88448000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>string</span></div><div class="t" style="left:463.09344px;top:436.79999999999995px;width:109.17984000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>항상</span></div><div class="t" style="left:614.5132799999999px;top:436.79999999999995px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>불가</span></div><div class="t" style="left:696.0470399999999px;top:436.79999999999995px;width:237.30432000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>job-로 시작</span></div><div class="t" style="left:975.5913599999999px;top:436.79999999999995px;width:225.65664000000004px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>조회용 작업 ID</span></div><div class="r" style="left:57.599999999999994px;top:480.96px;width:1164.768px;height:44.160000000000004px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:480.96px;width:132.4752px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>status</span></div><div class="t" style="left:253.4352px;top:480.96px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>응답</span></div><div class="t m" style="left:334.96896000000004px;top:480.96px;width:85.88448000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>string</span></div><div class="t" style="left:463.09344px;top:480.96px;width:109.17984000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>항상</span></div><div class="t" style="left:614.5132799999999px;top:480.96px;width:39.29376000000001px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>불가</span></div><div class="t" style="left:696.0470399999999px;top:480.96px;width:237.30432000000002px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>queued</span></div><div class="t" style="left:975.5913599999999px;top:480.96px;width:225.65664000000004px;height:44.160000000000004px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>접수 상태</span></div><div class="r" style="left:57.599999999999994px;top:553.92px;width:1164.768px;height:103.68px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:553.92px;width:1107.1680000000001px;height:103.68px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>예시 JSON 하나로는 규칙이 보이지 않는다. 필드마다 타입·필수·빈값·제약을 적고, 예시 값과 맞춘다.
|
|
빈값은 ""(빈 문자열)이나 null을 받아도 되는지다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>오류 응답도 설계의 일부다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>19</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:1164.768px;height:48px;background:#22375A;border-radius:0px"></div><div class="t" style="left:78.72px;top:168px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>상태 코드</span></div><div class="t" style="left:311.6736000000001px;top:168px;width:493.55328000000003px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>발생 조건</span></div><div class="t" style="left:847.4668800000002px;top:168px;width:353.78112000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>오류 코드(예시)</span></div><div class="r" style="left:57.599999999999994px;top:216px;width:1164.768px;height:48px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:216px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>422 (또는 400)</span></div><div class="t" style="left:311.6736000000001px;top:216px;width:493.55328000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>형식이 잘못된 입력 (허용 밖 action, 길이 초과)</span></div><div class="t m" style="left:847.4668800000002px;top:216px;width:353.78112000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>VALIDATION_ERROR</span></div><div class="r" style="left:57.599999999999994px;top:264px;width:1164.768px;height:48px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:264px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>401</span></div><div class="t" style="left:311.6736000000001px;top:264px;width:493.55328000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>토큰 누락·만료</span></div><div class="t m" style="left:847.4668800000002px;top:264px;width:353.78112000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>UNAUTHORIZED</span></div><div class="r" style="left:57.599999999999994px;top:312px;width:1164.768px;height:48px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:312px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>403</span></div><div class="t" style="left:311.6736000000001px;top:312px;width:493.55328000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>역할 권한 부족</span></div><div class="t m" style="left:847.4668800000002px;top:312px;width:353.78112000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>FORBIDDEN</span></div><div class="r" style="left:57.599999999999994px;top:360px;width:1164.768px;height:48px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:360px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>403</span></div><div class="t" style="left:311.6736000000001px;top:360px;width:493.55328000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>승인이 없거나, 승인 전이거나, 다른 대상의 승인</span></div><div class="t m" style="left:847.4668800000002px;top:360px;width:353.78112000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>APPROVAL_REQUIRED</span></div><div class="r" style="left:57.599999999999994px;top:408px;width:1164.768px;height:48px;background:#1A2B45;border-radius:0px"></div><div class="t m" style="left:78.72px;top:408px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>404</span></div><div class="t" style="left:311.6736000000001px;top:408px;width:493.55328000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>장애 ID 없음</span></div><div class="t m" style="left:847.4668800000002px;top:408px;width:353.78112000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>INCIDENT_NOT_FOUND</span></div><div class="r" style="left:57.599999999999994px;top:456px;width:1164.768px;height:48px;background:#15233A;border-radius:0px"></div><div class="t m" style="left:78.72px;top:456px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>409</span></div><div class="t" style="left:311.6736000000001px;top:456px;width:493.55328000000003px;height:48px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>같은 장애에 실행 중인 복구가 있음</span></div><div class="t m" style="left:847.4668800000002px;top:456px;width:353.78112000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>DUPLICATE_JOB</span></div><div class="r" style="left:57.599999999999994px;top:532.8px;width:1164.768px;height:103.68px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:532.8px;width:1107.1680000000001px;height:103.68px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>입력 형식은 Pydantic이 검사하고(422), 권한과 승인은 서버 로직이 검사한다(403). 두 검사를 섞지 않는다.
|
|
FastAPI는 형식 오류를 기본 422로 응답한다. 400과 공통 오류 형식을 쓰려면 예외 핸들러를 추가한다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>입력 형식은 Pydantic 모델로 검사한다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>20</span></div><div class="t ul" style="left:57.599999999999994px;top:172.8px;width:412.79999999999995px;height:441.59999999999997px;font-size:21.333333333333332px;color:#CBD5E1;text-align:left;justify-content:flex-start;--gap:18.666666666666668px;"><div class="li">Literal: 허용하는 값의 목록</div><div class="li">Field: 길이와 형식 제한</div><div class="li">여기서 걸리면 FastAPI가 422로 응답한다.</div><div class="li">승인이 실제로 있는지는 여기서 판단하지 않는다. 서버가 DB의 승인 기록으로 확인한다 (다음 장).</div></div><div class="r" style="left:508.79999999999995px;top:168px;width:713.5680000000001px;height:354.24px;background:#0A1322;border-radius:9.600000000000001px"></div><div class="t m" style="left:537.5999999999999px;top:179.52px;width:655.9680000000001px;height:28.799999999999997px;font-size:16px;color:#A8B8CC;text-align:left;justify-content:center;"><span>schemas.py</span></div><div class="t m" style="left:537.5999999999999px;top:216px;width:655.9680000000001px;height:296.64px;font-size:17.333333333333332px;color:#F1F5F9;text-align:left;justify-content:flex-start;"><span>from typing import Literal
|
|
from pydantic import BaseModel, Field
|
|
|
|
class RecoveryRequest(BaseModel):
|
|
action: Literal["restart", "reconnect", "fallback"]
|
|
target_id: str = Field(min_length=1, max_length=64)
|
|
approval_id: str | None = Field(
|
|
default=None, pattern=r"^apr-[0-9a-z-]+$")
|
|
|
|
# 422: action="reboot" (허용 값 밖)
|
|
# 422: target_id="" (길이 제한)
|
|
# 통과: approval_id 없음 → 승인 검사는 서버에서 403</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>권한과 승인은 서버가 확인한다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>21</span></div><div class="t ul" style="left:57.599999999999994px;top:172.8px;width:412.79999999999995px;height:441.59999999999997px;font-size:21.333333333333332px;color:#CBD5E1;text-align:left;justify-content:flex-start;--gap:18.666666666666668px;"><div class="li">역할: 이 사용자가 복구를 요청할 수 있는가</div><div class="li">소유권: 이 사용자가 볼 수 있는 장애인가</div><div class="li">승인 상태: 승인 기록이 있고, 승인됐고, 같은 장애와 대상에 대한 것인가</div><div class="li">요청 본문의 approval_id는 주장일 뿐이다.</div></div><div class="r" style="left:508.79999999999995px;top:168px;width:713.5680000000001px;height:471.84000000000003px;background:#0A1322;border-radius:9.600000000000001px"></div><div class="t m" style="left:537.5999999999999px;top:179.52px;width:655.9680000000001px;height:28.799999999999997px;font-size:16px;color:#A8B8CC;text-align:left;justify-content:center;"><span>routes.py (형식 예시)</span></div><div class="t m" style="left:537.5999999999999px;top:216px;width:655.9680000000001px;height:414.24px;font-size:17.333333333333332px;color:#F1F5F9;text-align:left;justify-content:flex-start;"><span>RISKY = {"restart"}
|
|
|
|
@router.post("/incidents/{incident_id}/recovery",
|
|
status_code=202)
|
|
def request_recovery(incident_id: str, body: RecoveryRequest,
|
|
user: User = Depends(current_user)):
|
|
if user.role not in {"operator", "admin"}:
|
|
raise HTTPException(403, {"code": "FORBIDDEN"})
|
|
incident = find_incident(incident_id, user) # 없으면 404
|
|
if body.action in RISKY:
|
|
apr = find_approval(body.approval_id)
|
|
if not (apr and apr.status == "approved"
|
|
and apr.incident_id == incident.id
|
|
and apr.target_id == body.target_id):
|
|
raise HTTPException(
|
|
403, {"code": "APPROVAL_REQUIRED"})
|
|
return enqueue_job(incident, body)</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>타임아웃·재시도·중복 실행 방지 규칙을 적는다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>22</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:1164.768px;height:48px;background:#22375A;border-radius:0px"></div><div class="t" style="left:78.72px;top:168px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>항목</span></div><div class="t" style="left:311.6736000000001px;top:168px;width:889.5744000000002px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>규칙 (예시 값)</span></div><div class="r" style="left:57.599999999999994px;top:216px;width:1164.768px;height:53.760000000000005px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:216px;width:190.71360000000004px;height:53.760000000000005px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>타임아웃</span></div><div class="t" style="left:311.6736000000001px;top:216px;width:889.5744000000002px;height:53.760000000000005px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>API 응답 10초, Tool 호출 30초. 넘으면 TOOL_TIMEOUT으로 처리한다</span></div><div class="r" style="left:57.599999999999994px;top:269.76px;width:1164.768px;height:53.760000000000005px;background:#15233A;border-radius:0px"></div><div class="t" style="left:78.72px;top:269.76px;width:190.71360000000004px;height:53.760000000000005px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>재시도 대상</span></div><div class="t" style="left:311.6736000000001px;top:269.76px;width:889.5744000000002px;height:53.760000000000005px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>타임아웃·429·5xx 같은 일시적 오류만. 400·401·403·404·422는 재시도하지 않는다</span></div><div class="r" style="left:57.599999999999994px;top:323.52px;width:1164.768px;height:53.760000000000005px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:323.52px;width:190.71360000000004px;height:53.760000000000005px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>재시도 횟수</span></div><div class="t" style="left:311.6736000000001px;top:323.52px;width:889.5744000000002px;height:53.760000000000005px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>최대 2회, 1초 → 2초 간격으로 늘린다 (지수 백오프)</span></div><div class="r" style="left:57.599999999999994px;top:377.28000000000003px;width:1164.768px;height:53.760000000000005px;background:#15233A;border-radius:0px"></div><div class="t" style="left:78.72px;top:377.28000000000003px;width:190.71360000000004px;height:53.760000000000005px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>중복 실행 방지</span></div><div class="t" style="left:311.6736000000001px;top:377.28000000000003px;width:889.5744000000002px;height:53.760000000000005px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>같은 Idempotency-Key로 다시 오면 처음 만든 job을 그대로 돌려준다</span></div><div class="r" style="left:57.599999999999994px;top:431.04px;width:1164.768px;height:53.760000000000005px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:431.04px;width:190.71360000000004px;height:53.760000000000005px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>동시 실행</span></div><div class="t" style="left:311.6736000000001px;top:431.04px;width:889.5744000000002px;height:53.760000000000005px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>같은 장애에 실행 중인 복구가 있으면 409 DUPLICATE_JOB</span></div><div class="r" style="left:57.599999999999994px;top:484.80000000000007px;width:1164.768px;height:53.760000000000005px;background:#15233A;border-radius:0px"></div><div class="t" style="left:78.72px;top:484.80000000000007px;width:190.71360000000004px;height:53.760000000000005px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>변경 작업</span></div><div class="t" style="left:311.6736000000001px;top:484.80000000000007px;width:889.5744000000002px;height:53.760000000000005px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>응답이 끊겨도 이미 실행됐을 수 있다. 상태를 조회한 뒤 재시도한다</span></div><div class="r" style="left:57.599999999999994px;top:567.3600000000001px;width:1164.768px;height:71.03999999999999px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:567.3600000000001px;width:1107.1680000000001px;height:71.03999999999999px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>숫자는 예시다. 팀이 정한 값을 적고, Auto-Healing 구현 결과서의 재시도 규칙과 같게 맞춘다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>REST API와 Tool은 호출하는 주체가 다르다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>23</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:1164.768px;height:48px;background:#22375A;border-radius:0px"></div><div class="t" style="left:78.72px;top:168px;width:190.71360000000004px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>구분</span></div><div class="t" style="left:311.6736000000001px;top:168px;width:400.37184px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>REST API</span></div><div class="t" style="left:754.28544px;top:168px;width:446.96255999999994px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>Tool (Function Calling)</span></div><div class="r" style="left:57.599999999999994px;top:216px;width:1164.768px;height:76.80000000000001px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:216px;width:190.71360000000004px;height:76.80000000000001px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>호출 주체</span></div><div class="t" style="left:311.6736000000001px;top:216px;width:400.37184px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>화면(프런트엔드), 외부 시스템</span></div><div class="t" style="left:754.28544px;top:216px;width:446.96255999999994px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>에이전트(LLM)</span></div><div class="r" style="left:57.599999999999994px;top:292.79999999999995px;width:1164.768px;height:76.80000000000001px;background:#15233A;border-radius:0px"></div><div class="t" style="left:78.72px;top:292.79999999999995px;width:190.71360000000004px;height:76.80000000000001px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>호출 방법</span></div><div class="t" style="left:311.6736000000001px;top:292.79999999999995px;width:400.37184px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>HTTP 메서드 + 경로</span></div><div class="t" style="left:754.28544px;top:292.79999999999995px;width:446.96255999999994px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>Tool 이름 + JSON 인자</span></div><div class="r" style="left:57.599999999999994px;top:369.59999999999997px;width:1164.768px;height:76.80000000000001px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:369.59999999999997px;width:190.71360000000004px;height:76.80000000000001px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>권한 확인</span></div><div class="t" style="left:311.6736000000001px;top:369.59999999999997px;width:400.37184px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>JWT에 담긴 사용자 역할</span></div><div class="t" style="left:754.28544px;top:369.59999999999997px;width:446.96255999999994px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>에이전트 허용 목록 + 요청한 사용자의 권한</span></div><div class="r" style="left:57.599999999999994px;top:446.4px;width:1164.768px;height:76.80000000000001px;background:#15233A;border-radius:0px"></div><div class="t" style="left:78.72px;top:446.4px;width:190.71360000000004px;height:76.80000000000001px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>문서에 적는 것</span></div><div class="t" style="left:311.6736000000001px;top:446.4px;width:400.37184px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>요청·응답·상태 코드</span></div><div class="t" style="left:754.28544px;top:446.4px;width:446.96255999999994px;height:76.80000000000001px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>입력 스키마·출력·실패 처리·실행 조건</span></div><div class="r" style="left:57.599999999999994px;top:551.9999999999999px;width:1164.768px;height:71.03999999999999px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:551.9999999999999px;width:1107.1680000000001px;height:71.03999999999999px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>LLM이 만든 인자도 사용자 입력처럼 다룬다. Tool 안에서 같은 검증을 한 번 더 한다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>Tool 정의는 에이전트가 읽는 명세다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>24</span></div><div class="t ul" style="left:57.599999999999994px;top:172.8px;width:412.79999999999995px;height:441.59999999999997px;font-size:21.333333333333332px;color:#CBD5E1;text-align:left;justify-content:flex-start;--gap:18.666666666666668px;"><div class="li">이름은 동사_명사: restart_service</div><div class="li">호출 주체와 권한: RecoveryAgent, recovery.execute</div><div class="li">실행 조건: 서버가 승인 상태를 확인한 뒤</div><div class="li">출력과 실패 처리: 다음 장의 형식으로 적는다</div><div class="li">description은 LLM이 언제 쓸지 판단하는 근거다. 구체적으로 쓴다.</div></div><div class="r" style="left:508.79999999999995px;top:168px;width:713.5680000000001px;height:377.76px;background:#0A1322;border-radius:9.600000000000001px"></div><div class="t m" style="left:537.5999999999999px;top:179.52px;width:655.9680000000001px;height:28.799999999999997px;font-size:16px;color:#A8B8CC;text-align:left;justify-content:center;"><span>Tool 입력 스키마</span></div><div class="t m" style="left:537.5999999999999px;top:216px;width:655.9680000000001px;height:320.15999999999997px;font-size:17.333333333333332px;color:#F1F5F9;text-align:left;justify-content:flex-start;"><span>{
|
|
"name": "restart_service",
|
|
"description": "승인된 대상 서비스를 재시작한다",
|
|
"parameters": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target_id": {"type": "string"},
|
|
"approval_id": {"type": "string"},
|
|
"request_id": {"type": "string"}
|
|
},
|
|
"required": ["target_id", "approval_id", "request_id"]
|
|
}
|
|
}</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>Tool의 성공·실패 출력과 실패 후 처리</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>25</span></div><div class="t ul" style="left:57.599999999999994px;top:172.8px;width:412.79999999999995px;height:441.59999999999997px;font-size:21.333333333333332px;color:#CBD5E1;text-align:left;justify-content:flex-start;--gap:18.666666666666668px;"><div class="li">성공과 실패의 형식을 하나로 맞춘다 (ok 필드)</div><div class="li">TOOL_TIMEOUT: 실제로 실행됐는지 조회한 뒤 1회 재시도</div><div class="li">TARGET_NOT_FOUND: 재시도하지 않고 진단 단계로 되돌린다</div><div class="li">APPROVAL_REQUIRED: 실행을 멈추고 승인을 요청한다</div><div class="li">retryable로 에이전트가 재시도 여부를 판단한다</div></div><div class="r" style="left:508.79999999999995px;top:168px;width:713.5680000000001px;height:330.71999999999997px;background:#0A1322;border-radius:9.600000000000001px"></div><div class="t m" style="left:537.5999999999999px;top:179.52px;width:655.9680000000001px;height:28.799999999999997px;font-size:16px;color:#A8B8CC;text-align:left;justify-content:center;"><span>restart_service 출력 (형식 예시)</span></div><div class="t m" style="left:537.5999999999999px;top:216px;width:655.9680000000001px;height:273.12px;font-size:17.333333333333332px;color:#F1F5F9;text-align:left;justify-content:flex-start;"><span>// 성공
|
|
{"ok": true,
|
|
"data": {"job_id": "job-001", "status": "started"},
|
|
"request_id": "req-001"}
|
|
|
|
// 실패
|
|
{"ok": false,
|
|
"error": {"code": "TOOL_TIMEOUT",
|
|
"message": "30초 안에 응답 없음",
|
|
"retryable": true},
|
|
"request_id": "req-001"}</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>Tool 실행 전에 서버가 네 가지를 확인한다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>26</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:567.984px;height:225.60000000000002px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:196.79999999999998px;width:510.384px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>① 에이전트 허용 목록</span></div><div class="t" style="left:86.39999999999999px;top:249.59999999999997px;width:510.384px;height:38.400000000000006px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>허용 목록은 첫 번째 관문일 뿐이다.</span></div><div class="r" style="left:86.39999999999999px;top:310.0799999999999px;width:510.384px;height:54.720000000000006px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:103.67999999999998px;top:310.0799999999999px;width:475.824px;height:54.720000000000006px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>RecoveryAgent → restart_service</span></div><div class="r" style="left:654.384px;top:168px;width:567.984px;height:225.60000000000002px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:683.184px;top:196.79999999999998px;width:510.384px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>② 요청한 사용자의 권한</span></div><div class="t" style="left:683.184px;top:249.59999999999997px;width:510.384px;height:38.400000000000006px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>사용자가 못 하는 일은 에이전트도 못 한다.</span></div><div class="r" style="left:683.184px;top:310.0799999999999px;width:510.384px;height:54.720000000000006px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:700.4639999999999px;top:310.0799999999999px;width:475.824px;height:54.720000000000006px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>user.role in {operator, admin}</span></div><div class="r" style="left:57.599999999999994px;top:422.40000000000003px;width:567.984px;height:225.60000000000002px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:451.20000000000005px;width:510.384px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>③ 데이터 소유권</span></div><div class="t" style="left:86.39999999999999px;top:504px;width:510.384px;height:38.400000000000006px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>대상이 그 사용자·조직의 자원인가.</span></div><div class="r" style="left:86.39999999999999px;top:564.48px;width:510.384px;height:54.720000000000006px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:103.67999999999998px;top:564.48px;width:475.824px;height:54.720000000000006px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>target_id in user.assets</span></div><div class="r" style="left:654.384px;top:422.40000000000003px;width:567.984px;height:225.60000000000002px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:683.184px;top:451.20000000000005px;width:510.384px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>④ 실제 승인 상태</span></div><div class="t" style="left:683.184px;top:504px;width:510.384px;height:38.400000000000006px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>LLM이 넘긴 승인 ID를 그대로 믿지 않는다.</span></div><div class="r" style="left:683.184px;top:564.48px;width:510.384px;height:54.720000000000006px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:700.4639999999999px;top:564.48px;width:475.824px;height:54.720000000000006px;font-size:18.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>approval.status == "approved"</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>Tool 호출 흐름을 한 줄로 그린다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>27</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>요청 하나가 어떤 순서로 에이전트와 Tool을 거치는지 문서에 남긴다</span></div><div class="r" style="left:57.599999999999994px;top:240px;width:160.52800000000002px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:72px;top:268.79999999999995px;width:131.728px;height:48px;font-size:21.333333333333332px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>API 요청</span></div><div class="t" style="left:72px;top:331.20000000000005px;width:131.728px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>인증과
|
|
입력 검증</span></div><div class="t" style="left:218.128px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:258.44800000000004px;top:240px;width:160.52800000000002px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:272.848px;top:268.79999999999995px;width:131.728px;height:48px;font-size:21.333333333333332px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>Supervisor</span></div><div class="t" style="left:272.848px;top:331.20000000000005px;width:131.728px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>작업 분배</span></div><div class="t" style="left:418.976px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:459.29600000000005px;top:240px;width:160.52800000000002px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:473.696px;top:268.79999999999995px;width:131.728px;height:76.80000000000001px;font-size:21.333333333333332px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>Diagnosis
|
|
Agent</span></div><div class="t" style="left:473.696px;top:355.20000000000005px;width:131.728px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>원인 진단</span></div><div class="t" style="left:619.8240000000001px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:660.144px;top:240px;width:160.52800000000002px;height:220.79999999999998px;background:#0F766E;border-radius:9.600000000000001px"></div><div class="t" style="left:674.5440000000001px;top:268.79999999999995px;width:131.728px;height:48px;font-size:21.333333333333332px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>승인 확인</span></div><div class="t" style="left:674.5440000000001px;top:331.20000000000005px;width:131.728px;height:86.4px;font-size:18.666666666666668px;color:#F1F5F9;text-align:center;justify-content:flex-start;"><span>서버가 DB의
|
|
승인 기록 확인</span></div><div class="t" style="left:820.672px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:860.9920000000001px;top:240px;width:160.52800000000002px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:875.392px;top:268.79999999999995px;width:131.728px;height:76.80000000000001px;font-size:21.333333333333332px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>Recovery
|
|
Agent</span></div><div class="t" style="left:875.392px;top:355.20000000000005px;width:131.728px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>복구 Tool
|
|
호출</span></div><div class="t" style="left:1021.5200000000002px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:1061.8400000000001px;top:240px;width:160.52800000000002px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:1076.2400000000002px;top:268.79999999999995px;width:131.728px;height:76.80000000000001px;font-size:21.333333333333332px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>Verification
|
|
Agent</span></div><div class="t" style="left:1076.2400000000002px;top:355.20000000000005px;width:131.728px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>정상화 확인,
|
|
상태 기록</span></div><div class="r" style="left:57.599999999999994px;top:513.5999999999999px;width:1164.768px;height:71.03999999999999px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:513.5999999999999px;width:1107.1680000000001px;height:71.03999999999999px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>API의 X-Request-ID와 Tool의 request_id를 같은 값으로 이어 두면, 로그에서 요청 전체를 한 번에 추적할 수 있다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>응답 방식은 작업 시간에 맞춰 고른다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>28</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>모든 에이전트 API를 비동기로 만들 필요는 없다. 팀이 실제로 쓰는 방식만 문서에 적는다</span></div><div class="r" style="left:57.599999999999994px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>① 바로 응답</span></div><div class="t" style="left:86.39999999999999px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>대부분은 200으로 끝낸다</span></div><div class="t" style="left:86.39999999999999px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>몇 초 안에 끝나는 조회와 처리는 결과를 바로 돌려준다.</span></div><div class="r" style="left:86.39999999999999px;top:509.76px;width:311.456px;height:80.64000000000001px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:103.67999999999998px;top:509.76px;width:276.896px;height:80.64000000000001px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET /incidents/{id}
|
|
→ 200 {"id": "inc-001"}</span></div><div class="r" style="left:455.456px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:484.256px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>② 접수와 조회</span></div><div class="t" style="left:484.256px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>오래 걸리면 202</span></div><div class="t" style="left:484.256px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>접수만 하고 job_id를 돌려준다. 결과는 조회로 확인한다.</span></div><div class="r" style="left:484.256px;top:509.76px;width:311.456px;height:80.64000000000001px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:501.53599999999994px;top:509.76px;width:276.896px;height:80.64000000000001px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>POST …/recovery → 202
|
|
GET /recovery-jobs/{id}</span></div><div class="r" style="left:853.3120000000001px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:882.1120000000001px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>③ 스트리밍 (쓰는 팀만)</span></div><div class="t" style="left:882.1120000000001px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>진행 상황을 흘려보낸다</span></div><div class="t" style="left:882.1120000000001px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>실시간 화면을 만드는 팀만 이벤트 종류를 명세한다.</span></div><div class="r" style="left:882.1120000000001px;top:509.76px;width:311.456px;height:80.64000000000001px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:899.392px;top:509.76px;width:276.896px;height:80.64000000000001px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>POST /api/v1/chat/stream
|
|
→ text/event-stream</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>작업 조회 응답은 상태·결과·실패를 구분한다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>29</span></div><div class="t ul" style="left:57.599999999999994px;top:172.8px;width:412.79999999999995px;height:441.59999999999997px;font-size:21.333333333333332px;color:#CBD5E1;text-align:left;justify-content:flex-start;--gap:18.666666666666668px;"><div class="li">상태 값: queued → running → succeeded 또는 failed</div><div class="li">작업이 실패해도 조회 요청은 성공했으므로 200이다. 실패는 status와 error로 알린다.</div><div class="li">결과는 succeeded일 때만 result에 담는다.</div><div class="li">없는 job_id는 404다.</div></div><div class="r" style="left:508.79999999999995px;top:168px;width:713.5680000000001px;height:401.28px;background:#0A1322;border-radius:9.600000000000001px"></div><div class="t m" style="left:537.5999999999999px;top:179.52px;width:655.9680000000001px;height:28.799999999999997px;font-size:16px;color:#A8B8CC;text-align:left;justify-content:center;"><span>GET /api/v1/recovery-jobs/{job_id} (형식 예시)</span></div><div class="t m" style="left:537.5999999999999px;top:216px;width:655.9680000000001px;height:343.67999999999995px;font-size:17.333333333333332px;color:#F1F5F9;text-align:left;justify-content:flex-start;"><span>GET /api/v1/recovery-jobs/job-001
|
|
|
|
// 처리 중
|
|
200 {"job_id": "job-001", "status": "running"}
|
|
|
|
// 성공
|
|
200 {"job_id": "job-001", "status": "succeeded",
|
|
"result": {"health": "ok"},
|
|
"finished_at": "2026-11-18T10:00:42+09:00"}
|
|
|
|
// 실패
|
|
200 {"job_id": "job-001", "status": "failed",
|
|
"error": {"code": "TOOL_TIMEOUT",
|
|
"message": "30초 안에 응답 없음"}}</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>다른 산출물과 연결한다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>30</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>문서마다 이름과 규칙이 따로 놀면 설계·구현·검증의 연결을 보여줄 수 없다</span></div><div class="r" style="left:57.599999999999994px;top:206.39999999999998px;width:567.984px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:235.2px;width:510.384px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>기획서</span></div><div class="t" style="left:86.39999999999999px;top:273.59999999999997px;width:510.384px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>요구사항 ID를 연결한다</span></div><div class="t" style="left:86.39999999999999px;top:326.4px;width:510.384px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>API마다 FR-01 같은 요구사항 번호를 붙인다.</span></div><div class="r" style="left:654.384px;top:206.39999999999998px;width:567.984px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:683.184px;top:235.2px;width:510.384px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>DB 스키마 설계서</span></div><div class="t" style="left:683.184px;top:273.59999999999997px;width:510.384px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>필드와 컬럼의 대응을 밝힌다</span></div><div class="t" style="left:683.184px;top:326.4px;width:510.384px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>이름은 달라도 된다. 어느 필드가 어느 컬럼에 저장되는지 분명하면 된다. ID 형식은 같게 쓴다.</span></div><div class="r" style="left:57.599999999999994px;top:441.59999999999997px;width:567.984px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:470.4px;width:510.384px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>AI 보안 가드레일 문서</span></div><div class="t" style="left:86.39999999999999px;top:508.79999999999995px;width:510.384px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>권한 규칙이 일치한다</span></div><div class="t" style="left:86.39999999999999px;top:561.5999999999999px;width:510.384px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>역할별·Tool별 권한표와 403 조건이 서로 같아야 한다.</span></div><div class="r" style="left:654.384px;top:441.59999999999997px;width:567.984px;height:206.39999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:683.184px;top:470.4px;width:510.384px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>통합 테스트 결과서</span></div><div class="t" style="left:683.184px;top:508.79999999999995px;width:510.384px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>오류 표가 테스트가 된다</span></div><div class="t" style="left:683.184px;top:561.5999999999999px;width:510.384px;height:57.60000000000005px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>"승인 없는 요청 → 403" 한 줄이 테스트 케이스 하나다.</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>자주 나오는 실수와 고치는 법</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>31</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:1164.768px;height:48px;background:#22375A;border-radius:0px"></div><div class="t" style="left:78.72px;top:168px;width:540.144px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>실수</span></div><div class="t" style="left:661.104px;top:168px;width:540.144px;height:48px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>이렇게 고친다</span></div><div class="r" style="left:57.599999999999994px;top:216px;width:1164.768px;height:74.88px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:216px;width:540.144px;height:74.88px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>같은 API인데 문서 안에서 경로나 필드명이 다르다
|
|
(/recover 와 /recovery, action 과 strategy)</span></div><div class="t" style="left:661.104px;top:216px;width:540.144px;height:74.88px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>API 목록 표를 기준으로 삼고 상세 명세를 거기에 맞춘다</span></div><div class="r" style="left:57.599999999999994px;top:290.88px;width:1164.768px;height:74.88px;background:#15233A;border-radius:0px"></div><div class="t" style="left:78.72px;top:290.88px;width:540.144px;height:74.88px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>JSON 예시만 있고 필드 규칙이 없다</span></div><div class="t" style="left:661.104px;top:290.88px;width:540.144px;height:74.88px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>필드 명세 표(타입·필수·빈값·제약)를 추가한다</span></div><div class="r" style="left:57.599999999999994px;top:365.76000000000005px;width:1164.768px;height:74.88px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:365.76000000000005px;width:540.144px;height:74.88px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>승인 없음을 Pydantic 오류(422)로 처리했다</span></div><div class="t" style="left:661.104px;top:365.76000000000005px;width:540.144px;height:74.88px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>형식 검증과 서버의 승인 검사(403)를 나눈다</span></div><div class="r" style="left:57.599999999999994px;top:440.6400000000001px;width:1164.768px;height:74.88px;background:#15233A;border-radius:0px"></div><div class="t" style="left:78.72px;top:440.6400000000001px;width:540.144px;height:74.88px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>Tool 허용 목록만 있고 서버 권한 검사가 없다</span></div><div class="t" style="left:661.104px;top:440.6400000000001px;width:540.144px;height:74.88px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>사용자 권한·소유권·승인 상태를 서버가 확인한다</span></div><div class="r" style="left:57.599999999999994px;top:515.5200000000001px;width:1164.768px;height:74.88px;background:#1A2B45;border-radius:0px"></div><div class="t" style="left:78.72px;top:515.5200000000001px;width:540.144px;height:74.88px;font-size:18.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>구현하면서 문서와 코드가 달라졌다</span></div><div class="t" style="left:661.104px;top:515.5200000000001px;width:540.144px;height:74.88px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>FastAPI의 /docs 화면과 대조하고 문서 버전을 올린다</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>우리 서비스의 대상과 행위로 바꿔 쓴다</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>32</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>아래는 실제 팀 주제와 관계없는 일반 가상 예시다. 형태만 참고한다</span></div><div class="r" style="left:57.599999999999994px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:86.39999999999999px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>가상 예시 ① 회의실 예약 비서</span></div><div class="t" style="left:86.39999999999999px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>대상: 회의실, 예약</span></div><div class="t" style="left:86.39999999999999px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>같은 시간 중복 예약을 막는 409가 핵심이다.</span></div><div class="r" style="left:86.39999999999999px;top:483.8399999999999px;width:311.456px;height:106.56px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:103.67999999999998px;top:483.8399999999999px;width:276.896px;height:106.56px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET /rooms?date=…
|
|
POST /reservations
|
|
Tool: check_availability</span></div><div class="r" style="left:455.456px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:484.256px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>가상 예시 ② 도서 추천 상담</span></div><div class="t" style="left:484.256px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>대상: 도서, 상담</span></div><div class="t" style="left:484.256px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>검색 조건을 쿼리 파라미터로 명세한다.</span></div><div class="r" style="left:484.256px;top:483.8399999999999px;width:311.456px;height:106.56px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:501.53599999999994px;top:483.8399999999999px;width:276.896px;height:106.56px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET /books?keyword=…
|
|
POST /consultations
|
|
Tool: search_books</span></div><div class="r" style="left:853.3120000000001px;top:206.39999999999998px;width:369.05600000000004px;height:412.79999999999995px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:882.1120000000001px;top:235.2px;width:311.456px;height:28.799999999999997px;font-size:18.666666666666668px;color:#2DD4BF;font-weight:700;text-align:left;justify-content:center;"><span>가상 예시 ③ 배송 지연 알림</span></div><div class="t" style="left:882.1120000000001px;top:273.59999999999997px;width:311.456px;height:40.32px;font-size:26.666666666666668px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>대상: 배송, 알림</span></div><div class="t" style="left:882.1120000000001px;top:326.4px;width:311.456px;height:96px;font-size:20px;color:#CBD5E1;text-align:left;justify-content:flex-start;"><span>외부 택배 API를 부르는 Tool의 실패 처리가 핵심이다.</span></div><div class="r" style="left:882.1120000000001px;top:483.8399999999999px;width:311.456px;height:106.56px;background:#0A1322;border-radius:5.76px"></div><div class="t m" style="left:899.392px;top:483.8399999999999px;width:276.896px;height:106.56px;font-size:16px;color:#2DD4BF;text-align:left;justify-content:center;"><span>GET /shipments/{id}
|
|
POST /shipments/{id}/notify
|
|
Tool: get_tracking</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>최종 제출 전 체크리스트</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>33</span></div><div class="r" style="left:57.599999999999994px;top:168px;width:570.384px;height:91.19999999999999px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="r" style="left:86.39999999999999px;top:199.20000000000002px;width:28.799999999999997px;height:28.799999999999997px;background:#1A2B45;border:1.6px solid #2DD4BF;border-radius:3.84px"></div><div class="t" style="left:139.2px;top:168px;width:464.784px;height:91.19999999999999px;font-size:20px;color:#F1F5F9;text-align:left;justify-content:center;"><span>구현할 API가 모두 목록 표에 있고 요구사항 ID와 연결된다</span></div><div class="r" style="left:57.599999999999994px;top:283.20000000000005px;width:570.384px;height:91.19999999999999px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="r" style="left:86.39999999999999px;top:314.40000000000003px;width:28.799999999999997px;height:28.799999999999997px;background:#1A2B45;border:1.6px solid #2DD4BF;border-radius:3.84px"></div><div class="t" style="left:139.2px;top:283.20000000000005px;width:464.784px;height:91.19999999999999px;font-size:20px;color:#F1F5F9;text-align:left;justify-content:center;"><span>서버 주소·인증·오류 형식·/docs·변경 이력이 있다</span></div><div class="r" style="left:57.599999999999994px;top:398.40000000000003px;width:570.384px;height:91.19999999999999px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="r" style="left:86.39999999999999px;top:429.59999999999997px;width:28.799999999999997px;height:28.799999999999997px;background:#1A2B45;border:1.6px solid #2DD4BF;border-radius:3.84px"></div><div class="t" style="left:139.2px;top:398.40000000000003px;width:464.784px;height:91.19999999999999px;font-size:20px;color:#F1F5F9;text-align:left;justify-content:center;"><span>구현할 API마다 상세 명세와 필드 명세 표가 있다</span></div><div class="r" style="left:57.599999999999994px;top:513.5999999999999px;width:570.384px;height:91.19999999999999px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="r" style="left:86.39999999999999px;top:544.8px;width:28.799999999999997px;height:28.799999999999997px;background:#1A2B45;border:1.6px solid #2DD4BF;border-radius:3.84px"></div><div class="t" style="left:139.2px;top:513.5999999999999px;width:464.784px;height:91.19999999999999px;font-size:20px;color:#F1F5F9;text-align:left;justify-content:center;"><span>형식 오류(422)와 권한·승인 오류(403)를 나눠 적었다</span></div><div class="r" style="left:651.984px;top:168px;width:570.384px;height:91.19999999999999px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="r" style="left:680.784px;top:199.20000000000002px;width:28.799999999999997px;height:28.799999999999997px;background:#1A2B45;border:1.6px solid #2DD4BF;border-radius:3.84px"></div><div class="t" style="left:733.584px;top:168px;width:464.784px;height:91.19999999999999px;font-size:20px;color:#F1F5F9;text-align:left;justify-content:center;"><span>202를 쓰는 API는 작업 상태·결과·실패 조회가 있다</span></div><div class="r" style="left:651.984px;top:283.20000000000005px;width:570.384px;height:91.19999999999999px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="r" style="left:680.784px;top:314.40000000000003px;width:28.799999999999997px;height:28.799999999999997px;background:#1A2B45;border:1.6px solid #2DD4BF;border-radius:3.84px"></div><div class="t" style="left:733.584px;top:283.20000000000005px;width:464.784px;height:91.19999999999999px;font-size:20px;color:#F1F5F9;text-align:left;justify-content:center;"><span>Tool마다 성공·실패 출력과 실패 후 처리가 있다</span></div><div class="r" style="left:651.984px;top:398.40000000000003px;width:570.384px;height:91.19999999999999px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="r" style="left:680.784px;top:429.59999999999997px;width:28.799999999999997px;height:28.799999999999997px;background:#1A2B45;border:1.6px solid #2DD4BF;border-radius:3.84px"></div><div class="t" style="left:733.584px;top:398.40000000000003px;width:464.784px;height:91.19999999999999px;font-size:20px;color:#F1F5F9;text-align:left;justify-content:center;"><span>타임아웃·재시도·중복 실행 방지 규칙이 있다</span></div><div class="r" style="left:651.984px;top:513.5999999999999px;width:570.384px;height:91.19999999999999px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="r" style="left:680.784px;top:544.8px;width:28.799999999999997px;height:28.799999999999997px;background:#1A2B45;border:1.6px solid #2DD4BF;border-radius:3.84px"></div><div class="t" style="left:733.584px;top:513.5999999999999px;width:464.784px;height:91.19999999999999px;font-size:20px;color:#F1F5F9;text-align:left;justify-content:center;"><span>ID 형식이 같고, 필드와 DB 컬럼의 대응이 분명하다</span></div></section>
|
|
<section class="slide"><h2 class="t" style="left:57.599999999999994px;top:43.2px;width:1164.768px;height:86.4px;font-size:42.666666666666664px;color:#F1F5F9;font-weight:700;text-align:left;justify-content:center;"><span>오늘 팀에서 할 일</span></h2><div class="t" style="left:57.599999999999994px;top:672px;width:576px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:left;justify-content:center;"><span>최종 프로젝트 · API 설계 문서 작성법</span></div><div class="t" style="left:1145.568px;top:672px;width:76.80000000000001px;height:28.799999999999997px;font-size:13.333333333333334px;color:#A8B8CC;text-align:right;justify-content:center;"><span>34</span></div><div class="t" style="left:57.599999999999994px;top:134.39999999999998px;width:1164.768px;height:43.2px;font-size:22.666666666666668px;color:#2DD4BF;text-align:left;justify-content:center;"><span>완벽한 문서보다 합의된 초안이 먼저다. 구현하면서 버전을 올린다</span></div><div class="r" style="left:57.599999999999994px;top:240px;width:260.952px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:72px;top:268.79999999999995px;width:232.15200000000004px;height:48px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>① API 목록 표</span></div><div class="t" style="left:72px;top:331.20000000000005px;width:232.15200000000004px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>요구사항 전체를
|
|
표 한 장으로</span></div><div class="t" style="left:318.552px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:358.872px;top:240px;width:260.952px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:373.27200000000005px;top:268.79999999999995px;width:232.15200000000004px;height:48px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>② 상세 명세 1개</span></div><div class="t" style="left:373.27200000000005px;top:331.20000000000005px;width:232.15200000000004px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>핵심 API 하나로
|
|
초안 쓰기</span></div><div class="t" style="left:619.8240000000001px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:660.144px;top:240px;width:260.952px;height:220.79999999999998px;background:#1A2B45;border-radius:9.600000000000001px"></div><div class="t" style="left:674.5440000000001px;top:268.79999999999995px;width:232.15200000000004px;height:48px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>③ Tool 정의 1개</span></div><div class="t" style="left:674.5440000000001px;top:331.20000000000005px;width:232.15200000000004px;height:86.4px;font-size:18.666666666666668px;color:#CBD5E1;text-align:center;justify-content:flex-start;"><span>핵심 Tool 하나로
|
|
초안 쓰기</span></div><div class="t" style="left:921.0960000000001px;top:240px;width:40.32px;height:220.79999999999998px;font-size:26.666666666666668px;color:#2DD4BF;text-align:center;justify-content:center;"><span>→</span></div><div class="r" style="left:961.4160000000002px;top:240px;width:260.952px;height:220.79999999999998px;background:#0F766E;border-radius:9.600000000000001px"></div><div class="t" style="left:975.8160000000001px;top:268.79999999999995px;width:232.15200000000004px;height:48px;font-size:24px;color:#F1F5F9;font-weight:700;text-align:center;justify-content:center;"><span>④ 팀 리뷰</span></div><div class="t" style="left:975.8160000000001px;top:331.20000000000005px;width:232.15200000000004px;height:86.4px;font-size:18.666666666666668px;color:#F1F5F9;text-align:center;justify-content:flex-start;"><span>프런트·백엔드·AI
|
|
담당이 함께 읽기</span></div><div class="r" style="left:57.599999999999994px;top:513.5999999999999px;width:1164.768px;height:103.68px;background:#0A1322;border-radius:7.68px"></div><div class="t" style="left:86.39999999999999px;top:513.5999999999999px;width:1107.1680000000001px;height:103.68px;font-size:18.666666666666668px;color:#CBD5E1;text-align:left;justify-content:center;"><span>②·③은 오늘의 초안 실습 범위다. 최종 제출에는 구현하기로 확정한 API·Tool 전체의 명세가 있어야 한다.
|
|
문서 머리말에 문서 버전과 작성 상태를 적는다. 예: 문서 버전 v0.1 | 작성 상태: 초안</span></div></section>
|
|
</main>
|
|
<div class="bar" id="bar"></div>
|
|
<script>
|
|
(function(){
|
|
var stage=document.querySelector('.stage'),slides=[].slice.call(document.querySelectorAll('.slide')),i=0,present=true,bar=document.getElementById('bar');
|
|
function fit(){
|
|
var s=present?Math.min(innerWidth/1280,innerHeight/720):Math.min(1,(innerWidth-32)/1280);
|
|
stage.style.transform='scale('+s+')';
|
|
stage.style.marginLeft=Math.max(0,(innerWidth-1280*s)/2)+'px';
|
|
stage.style.marginTop=present?Math.max(0,(innerHeight-720*s)/2)+'px':'16px';
|
|
stage.style.height=present?'720px':'';
|
|
}
|
|
function show(){
|
|
document.body.classList.toggle('present',present);
|
|
slides.forEach(function(el,k){el.classList.toggle('on',k===i)});
|
|
bar.textContent=present?(i+1)+' / '+slides.length+' · ←/→ 이동 · O 전체 보기 · F 전체 화면':'O 발표 보기 · 인쇄(Ctrl/⌘+P)로 PDF 저장';
|
|
fit(); if(!present) slides[i].scrollIntoView();
|
|
}
|
|
function go(d){i=Math.max(0,Math.min(slides.length-1,i+d));show()}
|
|
addEventListener('keydown',function(e){
|
|
if(['ArrowRight','PageDown',' ','Enter'].indexOf(e.key)>=0){e.preventDefault();go(1)}
|
|
else if(['ArrowLeft','PageUp','Backspace'].indexOf(e.key)>=0){e.preventDefault();go(-1)}
|
|
else if(e.key==='Home'){i=0;show()} else if(e.key==='End'){i=slides.length-1;show()}
|
|
else if(e.key==='o'||e.key==='O'){present=!present;show()}
|
|
else if(e.key==='f'||e.key==='F'){document.fullscreenElement?document.exitFullscreen():document.documentElement.requestFullscreen()}
|
|
});
|
|
stage.addEventListener('click',function(e){if(present)go(e.clientX<innerWidth/3?-1:1)});
|
|
addEventListener('resize',fit); show();
|
|
})();
|
|
</script>
|
|
</body></html> |