API 문서 완성도 검사

INFO

설정 요구 사항은 AI 기능 시작하기를 참조하십시오. 참고: 이 기능을 사용하려면 Apidog 버전 2.7.55 이상이 필요합니다.

개요

AI를 사용하여 현재 API 문서에 대해 API 문서 완성도 검사를 실행하고 상세한 검토 보고서를 생성할 수 있습니다. 이 보고서를 바탕으로 문서를 다듬고 개선할 수 있습니다. 이를 통해 협업이 더 원활해지고, 문서를 더 쉽게 읽을 수 있으며, 더 정확한 엔드포인트 사양 덕분에 모든 AI 기능의 효과도 향상됩니다.

검사 항목

API 문서 완성도 검사를 실행하기 전에 현재 API 문서의 설명과 정의가 완전한지 검토하는 것이 좋습니다. 검사는 다음 측면을 분석합니다.

1. 기본 정의

엔드포인트 문서가 다음 항목을 명확하고 정확하게 지정하는지 검사합니다.

요소	목적
요청 메서드	HTTP 메서드(GET, POST, PUT, DELETE)를 정의하여 요청 의미, 멱등성 및 매개변수 구조를 결정합니다.
요청 경로	엔드포인트를 고유하게 식별하고 경로 매개변수 구조를 추론하기 위한 전체 URL 경로(base URL 제외)입니다.
엔드포인트 이름 및 설명	독자와 AI가 비즈니스 로직을 이해하는 데 도움이 되도록 엔드포인트의 목적을 간략히 설명합니다.

2. 매개변수 설명

엔드포인트 문서가 다음 항목을 명확하고 정확하게 지정하는지 검사합니다.

요소	목적
매개변수 이름	매개변수 구조가 완전하고, 명명 방식이 일관되며, 각 매개변수가 올바른 위치(Params, Body, Headers, Cookies)에 있는지 확인합니다.
예시	일반적인 값, 형식, 데이터 유형 및 비즈니스 의미를 이해하는 데 도움이 되는 유효한 샘플 입력값을 제공합니다.
설명	매개변수의 의미, 목적 및 비즈니스 시나리오를 설명합니다.

요청 매개변수의 기본 정보는 AI의 도움을 받아 생성하거나 수정할 수 있습니다.

3. 매개변수 제약 조건

엔드포인트 문서가 다음 항목을 명확하고 정확하게 지정하는지 검사합니다.

제약 조건	목적
필수/Nullable	매개변수가 필수인지 여부와 null 값이 허용되는지 여부를 나타냅니다.
Enums/Const	가능한 enum 또는 상수 값과 그 의미를 나열합니다.
경계값	최솟값/최댓값, 길이 제한 및 기타 제약 조건을 제공합니다.
형식	특수 형식(date-time, email, uuid, binary, int64, json-string 등)을 설명합니다.

4. 응답

API 문서가 다음 항목을 명확하고 정확하게 지정하는지 검사합니다.

요소	목적
응답 본문	응답 콘텐츠 유형, 필드 설명, HTTP 상태 코드 및 오류 코드에 대한 완전한 구조를 제공합니다.

응답의 기본 정보도 AI의 도움을 받아 생성하거나 수정할 수 있습니다.