2026-11-16 14:00:42 +09:00
|
|
|
|
<!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>명세대로
|
2026-11-18 15:00:43 +09:00
|
|
|
|
�작하는지 확�</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.400000000
|
2026-11-16 14:00:42 +09:00
|
|
|
|
<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="lef
|
|
|
|
|
|
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>
|
2026-11-18 15:00:43 +09:00
|
|
|
|
<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.666666666666668p
|
2026-11-16 14:00:42 +09:00
|
|
|
|
�때는 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;"><s
|
2026-11-18 15:00:43 +09:00
|
|
|
|
<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>
|
2026-11-16 14:00:42 +09:00
|
|
|
|
<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
|
2026-11-18 15:00:43 +09:00
|
|
|
|
<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;to
|
|
|
|
|
|
ëª¨ë“ ìž�ì›�ì�˜ 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;
|
|
|
|
|
|
<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
|
2026-11-16 14:00:42 +09:00
|
|
|
|
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>
|
2026-11-18 15:00:43 +09:00
|
|
|
|
<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="
|
|
|
|
|
|
빈값� ""(빈 문�열)�나 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;hei
|
|
|
|
|
|
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
|
2026-11-16 14:00:42 +09:00
|
|
|
|
|
|
|
|
|
|
class RecoveryRequest(BaseModel):
|
|
|
|
|
|
action: Literal["restart", "reconnect", "fallback"]
|
|
|
|
|
|
target_id: str = Field(min_length=1, max_length=64)
|
2026-11-18 15:00:43 +09:00
|
|
|
|
approval_id: str | None = Field(
|
|
|
|
|
|
default=None, pattern=r"^apr-[0-9a-z-]+$")
|
2026-11-16 14:00:42 +09:00
|
|
|
|
|
2026-11-18 15:00:43 +09:00
|
|
|
|
# 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ì�
|
|
|
|
|
|
<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.666666666666
|
|
|
|
|
|
<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>{
|
2026-11-16 14:00:42 +09:00
|
|
|
|
"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>
|
2026-11-18 15:00:43 +09:00
|
|
|
|
<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.6
|
|
|
|
|
|
<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>ì�¸ì¦�ê³¼
|
2026-11-16 14:00:42 +09:00
|
|
|
|
ìž…ë ¥ ê²€ì¦�</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
|
2026-11-18 15:00:43 +09:00
|
|
|
|
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
|
2026-11-16 14:00:42 +09:00
|
|
|
|
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>
|
2026-11-18 15:00:43 +09:00
|
|
|
|
<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
|
2026-11-16 14:00:42 +09:00
|
|
|
|
→ text/event-stream</span></div></section>
|
2026-11-18 15:00:43 +09:00
|
|
|
|
<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
|
|
|
|
|
|
<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=…
|
2026-11-16 14:00:42 +09:00
|
|
|
|
POST /consultations
|
2026-11-18 15:00:43 +09:00
|
|
|
|
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.799999999
|
|
|
|
|
|
<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>
|
2026-11-16 14:00:42 +09:00
|
|
|
|
</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>
|