API 설계 지침 - Apidog Docs

Apidog 버전 2.7.22 이상이 필요합니다.

Apidog은 모든 API 문서를 OpenAPI (Swagger) Specification을 준수하여 설계할 것을 강력히 권장합니다. 이 사양을 따르는 것이 API에 중요한 이유를 이해하려면 이 문서를 참조하실 수 있습니다.

AI 기반 엔드포인트 준수 검사, AI 네이밍 등 Apidog의 여러 다른 기능은 완전하고 잘 정의된 API 설계 지침에 의존합니다. 표준화된 지침을 사용하면 다음과 같은 이점이 있습니다.

Apidog의 다른 기능이 더 효과적으로 작동합니다.

팀이 일관된 설계 원칙에 맞춰 정렬되고 이를 따릅니다.

Apidog에서는 폴더 트리 위의 "+"> "New APl design guidelines"를 클릭하여 새 API 설계 지침을 만들 수 있습니다.

새 API 설계 지침을 만들 때 두 가지 옵션이 제공됩니다.

예시 템플릿(권장)
Apidog에서 제공하는 완전한 API 설계 지침 템플릿을 사용합니다. 대부분의 경우 권장되는 선택입니다. 이 템플릿은 OAS(OpenAPI Specification)를 기반으로 하며, Microsoft의 API 설계 모범 사례를 참조하여 작성되었습니다.

빈 템플릿
빈 설계 템플릿을 만듭니다. 이 옵션은 상세한 내용 없이 사양의 기본 구조만 제공합니다. 이후 팀 고유의 API 설계 지침을 작성할 수 있습니다. 팀에 이미 확립된 표준과 모범 사례가 있다면, 이 옵션이 더 나은 시작점일 수 있습니다.

요구 사항에 맞는 템플릿을 선택하고 미리 본 다음 확인하면, 프로젝트 내에 새 API 설계 지침이 생성됩니다. 필요에 따라 해당 내용을 완전히 사용자 지정할 수 있습니다. 설계 지침은 모든 팀 구성원에게 사양의 중요성을 상기시키기 위해 폴더 트리 상단에 표시됩니다.

자세히 알아보기: 엔드포인트 준수 검사.