구조
야피는 제품의 개발을 위해 설계된 강력한 API를 관리 플랫폼, 테스터가 더 우아한 인터페이스 관리 서비스를 제공, 사용하기 쉬운, 효율적입니다. 개발자가 쉽게 API를 작성, 게시, 유지하는 데 도움이 될 수 있습니다, 야피는 뛰어난 상호 작용 경험을 사용자에게 제공, 개발자는 단순히 인터페이스 데이터 플랫폼은 도구를 제공합니다 사용하고 인터페이스를 관리 할 수있는 단 한번의 클릭을 작성할 수 있습니다.
재산
기반 Json5 및 Mockjs 반환 데이터 구조는 인터페이스 및 문서 효율성 시간을 정의
플랫 디자인 권리, 대규모 기업 프로젝트의 관리를 보장 할뿐만 아니라, 사용의 용이성을 보장하기 위해
유사 우편 배달부 디버깅 인터페이스
자동화 된 테스트, 주장 응답에 대한 지원
공통 랜덤 MockServer 모의 지원뿐만 아니라, 모의 기능을 원하는 증가 요청에 의해 설정된 필터링 규칙에 따라 외에도, 예상 데이터를 반환
지원 우편 배달부, HAR, 자신감 데이터 가져 오기
유출 된 정보를 더 이상 두려워 무료 및 오픈 소스, 네트워크 구축,
메인 페이지
API 기본 정보
매개 변수 및 응답
뽐내며 걷기
소개
자신감은 RESTful 웹 서비스의 생성, 설명, 시각화 통화에 대한 표준화하고 완전한 프레임 워크입니다. 자신감의 목표는 표준 REST API와 언어에 독립적 인 인터페이스를 정의하는 것입니다, 컴퓨터 사람들은 소스 코드, 문서 또는 네트워크 트래픽을 모니터링 기능 및 서비스의 이해에 액세스 할 필요 찾을 수 없다. 제대로 자신감으로 정의 할 때, 사용자가 이해하고 원격 서비스 및 원격 서비스 구현 로직 최소한의 상호 작용을 사용할 수 있습니다. 기본 프로그래밍 인터페이스는 비슷한 구현을 위해 그리고 자신감는 추측 호출 서비스를 제거했을 수 있습니다.
GitHub의 : HTTPS : //github.com/swagger-api
통합 된
봄 부팅이 우리가 spring4all의 패키지를 사용할 때 더 간단 같은 것입니다 통합 선발을위한 오픈 소스 패키지에서 사용할 수 있으며, 메이븐 의존성은 다음과 같다 :
<의존성>
<의 groupId> com.spring4all </의 groupId>
<artifactId를> 자신감 스프링 부팅 - 스타터 </ artifactId를>
<버전> 1.9.1.RELEASE </ 버전>
</ 의존성>
후 좋은 플러스 플러스 의존 @ EnableSwagger2Doc은 시작 클래스에 자신감을 활성화합니다.
용도
그런 다음 특정 사용을 설명하고, 비교적 간단하지 않습니다,이 인터페이스를하고있다 설명하기 위해 인터페이스에 몇 가지 메모를 추가하는 것입니다.
코멘트없이 기본값은 사용자의 인터페이스는 또한 @RestController에있는 검사 방법을 모두 표시 할 수 있습니다.
메인 페이지
인터페이스 목록
발생할 수있는 문제가 있습니다
일반적으로, 우리는 오류가 발생하면 예외가 포착 한 후 발신자에 대한 응답의 고정 된 형식으로 변환됩니다, 프로젝트에 글로벌 예외 처리를 실시한다.이 통합 API 데이터 형식을.
우리는 당신이 순수 JSON의 내용을 반환 할 수 있도록하는 것이 우리의 프로젝트를 매핑 리소스 파일을 생성하지 않는 SpringBoot에게 다음을 구성합니다.
spring.resources.add - 매핑 = 거짓
그러나 우리의 자신감-ui.html 자원 혼자 자신감-ui.html 관련지도에 필요하므로, 액세스 할 수 없습니다.
@Configuration
공용 클래스 WebAppConfigurer는 WebMvcConfigurationSupport를 {확장
@우세하다
보호 무효 addResourceHandlers (ResourceHandlerRegistry 레지스트리) {
registry.addResourceHandler ( "/ 자신감-ui.html")
.addResourceLocations ( "클래스 경로 : / META-INF / 자원 /");
registry.addResourceHandler ( "/ webjars / **")
.addResourceLocations ( "클래스 경로 : / META-INF / 자원 / webjars /");
super.addResourceHandlers (레지스트리);
}
}
ShowDoc
ShowDoc 온라인 API 문서는 매우 적합한 IT 팀, 기술 문서 도구이다.
홈 : HTTPS : //www.showdoc.cc/
GitHub의 : HTTPS : //github.com/star7th/showdoc
우리는 설명을 목적으로 문서 ShowDoc API 문서, 데이터 사전을 할 수 있습니다. 그들의 자신의 개인, 당신도 나와있는 온라인 공식 프로그램을 사용하여 배포 할 수 있습니다.
ShowDoc 지원 권한 관리, 인하 편집에 대한 지원, 수출 지원, 공유 및 기타 기능을 지원합니다.
API 문서
데이터 사전
뽑는-API
뽑는-API는 완전히 협업 관리 시스템 API의 무료 오픈 소스입니다. 공동 개발, 온라인 테스트, 문서 관리, 수출 인터페이스, 개인화 기능과 같은 맞춤형 기능을 제공.
재산
버그 간단하고 모든 변경 사항을 기록하는 효율적인 관리 시스템
팀워크, 액세스 제어, 변경 로그
데이터베이스 테이블, 가격 인하, 편안하고, 모의, PDF, 워드
크롬 오픈 소스 플러그인 크로스 도메인 지원, 로컬 온 라인 디버그 인터페이스