Apigit의 API 거버넌스

APIGit

2023-07-20

api-governance

API 거버넌스를 찾는 방법은 무엇입니까?

사양 파일을 편집하도록 선택하면 여러 가지 보기가 표시됩니다. 그중 하나가 거버넌스입니다. 이 보기에서 감사 결과를 확인하고 설정한 규칙에 따라 각 경고 또는 오류에 대한 설명을 제공할 수 있습니다.

api-governance-1

API 거버넌스가 수행하는 데 도움이 되는 것은 무엇입니까?

다음은 API 모범 사례의 핵심 사항입니다.

  • 정보: 각 API에 제목, 설명 및 기타 필요한 정보와 같은 필수 속성이 있는지 확인하세요.

  • 버전 관리: 각 API에 대해 표준 시맨틱 또는 날짜 기반 버전 관리를 사용하도록 합니다.

  • 작업: 각 개별 작업에 요약, 설명 및 ID가 포함되어 있는지 확인하십시오.

  • 매개변수: 매개변수 이름의 형식을 표준화하고 모든 매개변수에 적절한 설명이 있는지 확인합니다.

  • 응답: API 전반에서 상태 코드, 미디어 유형 및 스키마 응답의 공통 세트를 지지합니다.

  • 개요: JSON 스키마 구성 요소를 사용하여 모든 요청 및 응답 스키마를 표준화합니다.

무엇 향후 계획?

현재 우리는OpenAPI Best Practice. 향후 OWASP Top 10 Security 및 맞춤형 규칙 세트를 포함한 추가 규칙 세트를 도입할 계획입니다. 이러한 향후 추가 사항에 대해 계속 지켜봐 주시기 바랍니다.

API 거버넌스는 단순한 설계 및 표준 이상을 포함합니다. 사람들에게 권한을 부여하고 API의 가치를 극대화하는 데 중점을 둡니다. API 거버넌스는 자동화, 워크숍 및 교육 세션을 활용하여 사용자가 보안 조치, 제품 정의 및 구현 전략을 개발하는 데 도움을 줍니다. 효율성을 보장하려면 API 거버넌스의 모든 구성 요소와 영향을 인정하는 것이 중요합니다. 추가 지침이 필요하면 필수 API 거버넌스 주제에 대한 향후 게시물에 대한 Apigit 블로그를 계속 지켜봐 주십시오.