엔드포인트 규정 준수 검사

INFO

설정 요구 사항은 AI 기능 시작하기를 참조하십시오.

개요

AI를 사용하여 API 설계 가이드라인을 기반으로 현재 API 문서에 대한 엔드포인트 규정 준수 검사를 수행할 수 있습니다. AI는 API 문서를 개선하는 데 도움이 되는 종합 보고서를 생성하여, 문서가 설계 표준에 더 잘 부합하고 더욱 전문적이며 일관되고 읽기 쉽게 만들 수 있도록 지원합니다.

규정 준수 검사 평가 항목

AI는 여러 기준에 따라 엔드포인트를 분석합니다.

기준	설명
명명 규칙	엔드포인트 경로, 매개변수 및 필드가 표준 명명 패턴을 따르는지 확인합니다.
문서 완성도	설명, 예시 및 제약 조건이 제공되었는지 검증합니다.
HTTP 메서드 사용	GET, POST, PUT, DELETE 등의 올바른 사용을 보장합니다.
응답 구조	응답 형식 및 오류 처리를 검증합니다.
보안 관행	인증 및 권한 부여 요구 사항을 검토합니다.

엔드포인트 규정 준수 검사 사용하기

모든 API 문서 페이지의 오른쪽 상단 모서리에서 엔드포인트 규정 준수 검사 기능에 접근할 수 있습니다. 해당 기능을 클릭하기만 하면 AI 기반 엔드포인트 규정 준수 검사가 시작됩니다.

Endpoint compliance check 버튼을 클릭하면 AI가 API 설계 가이드라인을 기반으로 API 문서를 분석합니다. 그런 다음 각 평가 기준에 대한 점수와 함께 자세한 설명 및 개선 제안을 제공합니다.

엔드포인트 규정 준수 검사

개요#

규정 준수 검사 평가 항목#

엔드포인트 규정 준수 검사 사용하기#

개요

규정 준수 검사 평가 항목

엔드포인트 규정 준수 검사 사용하기