로그인가입
쉬움 내려받는 파일 B형 운영자 확인 AI 도움받아 만듦

코드에서 API 문서 만들기

엔드포인트 코드를 보고 사용 설명서를 만들어 줘요

파일로 내려받기

복사·내려받기를 하면 재사용 수가 1 올라가요. api-doc-from-code.md

열람 3재사용(복사·내려받기) 1만든 사람 기즈모 운영팀

1이게 뭐예요?

엔드포인트 코드를 보고 사용 설명서를 만들어 줘요. API 문서가 없어 곤란한 팀.

프롬프트 — AI에게 시키는 말(질문이나 부탁)이에요. 말하듯 써도 돼요.

2누구에게 쓸모 있어요?

API 문서가 없어 곤란한 팀.

3어떻게 써요?

따라 하기 3단계

1
[내용 복사하기]를 눌러요.
2
쓰는 AI 대화창(ChatGPT, Claude 등)을 열고 붙여넣어요.
3
[대괄호]를 내 상황으로 바꾸고 Enter를 눌러요.

4써 보면 뭐가 나와요?

요청/응답 예시와 오류 표가 있는 문서가 나와요.

내용 미리보기

읽기 전용
아래 코드는 API 엔드포인트야. 이 API를 처음 쓰는 개발자를 위한 문서를 만들어 줘. 각 엔드포인트마다: - 주소와 방식 (GET/POST 등), 하는 일 한 줄 - 요청: 필드 표 (이름 / 형식 / 필수 여부 / 설명) - 성공 응답 예시 - 오류 응답 표 (상태 코드 / 이유 / 해결 방법) - 인증이 필요한지 코드에서 확인할 수 없는 내용은 추측하지 말고 [확인 필요]로 표시해 줘. 코드: [여기에 붙여넣으세요] ※ 코드·로그를 붙여넣기 전에 키, 토큰, 비밀번호, 접속 주소 같은 비밀 값은 [비밀]로 바꿔 주세요.
파일 내려받기

안 될 때는요

  • AI가 엉뚱하게 답하면, 같은 내용을 한 번 더 붙여넣고 “처음부터 다시 해 줘”라고 말해 보세요.
  • [대괄호]가 그대로 남아 있지 않은지 확인해 보세요.
  • 그래도 안 되면 아래 신고하기로 알려 주세요.

댓글 0

아직 댓글이 없어요. 첫 댓글을 남겨 보세요.

로그인하면 댓글을 쓸 수 있어요. 아직 계정이 없다면 가입해 보세요.

비슷한 도구

내려받는 파일 B형 운영자 확인 쉬움

코드 리뷰 부탁하기

내 코드를 경험 많은 리뷰어처럼 점검해 줘요

개발 보조 · 가져간 횟수 1 · 기즈모 운영팀
내려받는 파일 B형 운영자 확인 쉬움

버그 원인 같이 찾기

증상과 코드로 원인 후보를 좁혀 가는 디버깅 대화를 해요

개발 보조 · 가져간 횟수 1 · 기즈모 운영팀
내려받는 파일 B형 운영자 확인 쉬움

에러 메시지 쉽게 읽기

무서운 에러 메시지의 뜻과 확인 순서를 알려 줘요

개발 보조 · 가져간 횟수 1 · 기즈모 운영팀