본문 바로가기

미니 프로젝트

이름생성기(가제) API 명세서

닉네임 생성

Method POST
URL /api/names/nickname
설명 키워드를 기반으로 게임 닉네임 5개 생성
요청 필드 keyword (string, 필수)
응답 필드 results (string[5])
성공 응답 예시 {"results":
["냥펀치마스터", "캣로그인증", "묘약중독자",
"야옹암살자", 털뭉치스나이퍼"]}

 

인스타 아이디 생성

Method POST
URL /api/names/instagram
설명 영문 인스타 아이디 5개 생성
요청 필드 keyword (string, 필수)
응답 필드 result (string[5])
성공 응답 예시 {"results":
["minsu.log", "_k.minsoo", "daily_minsu",
"minsu.archive", "msoo.days"]}

 

자동차 애칭

Method POST
URL /api/names/car
설명 키워드 + 차종 기반 자동차 애칭 5개 생성
keyword와 carType 중 최소 1개는 반드시 입력되어야 함
요청 필드 keyword (string, 조건부 필수),
carType (string, 조건부 필수)
응답 필드 result (string[5])
성공 응답 예시 {"results":
["모닝수", "민수르모닝", "굿모닝수",
"모닝카수카", "쑤모닝이"]}

 

에러 응답 (공통)

에러 응답 공통 구조

{
  "status": number
  "error": "string"
}

 

상태 코드 정의

상태 코드 error 설명
400 Bad Request 필수 값 누락, 조건 미충족 등 클라이언트 오류
500 Server Error GPT API 오류 등 서버 오류

 

401/ 403 상태 코드는 명세서에 포함하지 않음 이 서비스는 인증이 필요 없기 때문에 로그인이나 권한 검증이 없어 401이나 403 에러가 발생하지 않음

 

'미니 프로젝트' 카테고리의 다른 글

이름생성기(가제) 요구사항 정의  (3) 2025.05.18