OpenAPI로 실제 API 계약을 문서화하는 방법.
API 명세는 오류와 인증을 포함한 실제 계약을 반영해야 합니다. 그럴듯한 엔드포인트 설명을 지어내기보다 알 수 없는 동작을 표시하세요.
작업에 맞게 절차를 조정하세요.
지정한 OpenAPI 버전으로 실제 엔드포인트, 매개변수, 인증, 응답 계약을 문서화하세요. 가정만으로 완전해 보이는 계약을 만들지 말고 알려진 오류를 포함하며 알 수 없는 동작을 표시하세요.
- 제공할 내용
- 검증된 엔드포인트 설명과 예제 응답.
- 받을 결과
- 미해결 계약을 표시한 OpenAPI 초안.
입력과 결과를 확인하세요.
설명용 입력과 출력 · 실제 WebAct 실행이 아닌 학습용 예시
입력 항목 예시개
Produce an OpenAPI 3.1.1 JSON fragment for fictional GET /items. Confirmed response: status 200, application/json array, each item requires string id and name. Authentication and errors are not specified.
완성된 예시
{
"openapi": "3.1.1",
"info": {"title": "Illustrative Items API", "version": "0.1.0"},
"paths": {
"/items": {
"get": {
"description": "Draft: authentication and error responses remain unspecified.",
"responses": {
"200": {
"description": "Items",
"content": {"application/json": {"schema": {
"type": "array",
"items": {"type": "object", "required": ["id", "name"], "properties": {
"id": {"type": "string"}, "name": {"type": "string"}
}}
}}}
}
}
}
}
}
}이 입력을 프롬프트에 넣고 WebAct에 복사해 작업을 실행해 보세요. 결과는 설명용 예시와 다를 수 있습니다.
판단 기준과 문제 해결.
OpenAPI 초안에서 문서화되지 않은 엔드포인트의 인증을 지어내도 되나요?
누락을 기록하고 실제 요구사항을 요청하세요. 생성한 보안 스키마를 구현된 보호로 오해해서는 안 됩니다.
유효한 명세 문서인데 생성한 클라이언트가 실패하는 이유는 무엇인가요?
스키마와 상태 동작을 실제 API와 비교하세요. 구조적 유효성이 문서화된 계약과 구현의 일치를 보장하지는 않습니다.
이 워크플로의 참고 자료입니다.
직접 준비한 자료로 시도하세요.
작업 프롬프트의 예시를 내 자료로 바꾸세요. 필요한 요구 사항은 유지하고 작업을 WebAct에 복사하세요.
작업 맞춤 설정 및 복사 ↑