제품

API 설계

APIGit은 업계에서 REST API를 정의하기 위한 표준으로 널리 수용되고 지원되는 OpenAPI 사양 3.0.x를 활용합니다. 자체 개발하고 사용하기 쉬우며 완전히 시각화된 OpenAPI 편집기를 사용하면 OpenAPI 사양에 대한 사전 지식 없이도 API 사양을 빠르고 쉽게 작성할 수 있습니다. 시각적 인터페이스를 통해 누구나 쉽게 API 문서를 이해하고 작성할 수 있으므로 개발 프로세스가 간소화되고 업계 표준을 준수하는 고품질 API 작성에 집중할 수 있습니다.
API 사양 보기 모드 - 기본값
보기 모드에서는 시각적으로 보기 좋은 디자인 테마로 API 문서를 볼 수 있습니다. 또한 기본 설정에 따라 원래 swagger 테마로 전환할 수 있습니다. API 사양은 게시될 때 동일하게 나타납니다. '편집' 버튼을 클릭하면 API 편집 모드로 들어갈 수 있습니다.
API 사양 보기 모드 - swagger-ui 보기
Swagger 보기 모드에서는 API 사양을 Swagger 테마로 볼 수 있으므로 표준 형식의 API 문서를 쉽게 이해하고 상호 작용할 수 있습니다.
API 사양 보기 모드 - 코드 보기
코드 모드에서는 원시의 일반 API 사양 콘텐츠가 표시되어 기본 코드를 직접 볼 수 있습니다.
API 사양 보기 모드 - diff 보기
diff 보기 모드에서 하나의 API 사양을 다른 사양과 비교하고 차이점을 쉽게 식별할 수 있습니다.
API 사양 편집 모드 - 양식 보기
'편집' 버튼을 클릭하면 API 사양이 양식 편집 모드로 들어가 API를 수정하는 가장 간단한 방법이 됩니다. 이 모드는 사양이 완전히 시각화되어 쉽게 이해하고 편집할 수 있으므로 OpenAPI에 대한 지식이 필요하지 않습니다.
API 사양 편집 모드 - 코드 보기
코드 모드에서 원시 API 문서 내용을 볼 수 있으므로 쉽게 직접 편집하거나 사양 관련 문제를 해결할 수 있습니다.
API 사양 편집 모드 - diff 보기
diff 모드에서는 편집 중인 API 사양의 현재 버전을 원래 버전과 비교하고 콘텐츠를 직접 편집할 수 있습니다. 이렇게 하면 두 버전 간의 차이점을 쉽게 식별하고 해결할 수 있으므로 변경 사항이 정확하고 원래 버전과 일치하는지 확인할 수 있습니다.
API 사양 생성 또는 업로드
당사의 플랫폼은 빈 API 사양을 생성하거나 기존 사양을 리포지토리에 업로드하는 기능을 제공합니다. 또한 HAR 파일을 업로드하는 옵션을 지원하여 자동으로 API 사양으로 변환합니다.

© 2024 APIGit Inc.

제품
APIGit이란?
네이티브 Git 리포지토리
API 설계
API 문서
API 거버넌스
API 테스트
동적 모의 서버
마크다운 문서
팀 협업
계획 및 가격
회사
에 대한
블로그
문서
문의하기
법률 및 개인정보 보호
은둔
자귀
상표권
언어
사회의
Youtube
Twitter
LinkedIn
Github
사회의
Youtube
Twitter
LinkedIn
Github