국내 API 관리 툴인 Apifox는 사용하기 쉬운가요?

소프트웨어 개발 실무자로서 API 디버깅은 필수 기술이며 Postman은 이와 관련하여 훌륭한 업무를 수행합니다. 그러나 전체 소프트웨어 개발 프로세스에서 API 디버깅은 API 문서 정의, API Mock, API 자동화 테스트 등과 같이 Postman이 완료할 수 없거나 효율적으로 완료할 수 없는 많은 것들이 있습니다. Apifox는 이 문제를 해결하기 위해 탄생했습니다.

인터페이스 관리 현황

1. Swagger를 사용하여 API 문서 관리

2. Postman을 사용하여 MockJs 및 기타 도구를 사용하여 API 디버깅

4. API 자동화 테스트를 수행하려면

2. 문제

다른 도구 간의 데이터 일관성을 유지하는 것은 매우 어렵고 비효율적입니다. 그리고 이는 단순히 작업량의 문제가 아니라, 더 큰 문제는 여러 시스템 간의 데이터 불일치로 인해 비효율적인 협업이 발생하고, 잦은 문제가 발생하며, 개발 및 테스터의 비참한 문제가 발생한다는 것입니다.

개발자가 Swagger에서 문서를 정의한 후 인터페이스를 디버깅할 때 Postman으로 이동하여 다시 정의해야 합니다. 프런트 엔드에서 Mock 데이터를 개발할 때 MockJs에서 다시 정의해야 하고, Mock 규칙도 수동으로 설정해야 합니다. 테스터는 JMeter로 이동하여 다시 정의해야 합니다. 프론트엔드는 MockJs Mock의 데이터를 기반으로 개발되었고, 백엔드는 Swagger에서 정의한 인터페이스 문서를 기반으로 개발되었기 때문에 둘 다 테스트를 즉시 통과할 수 있을 것이라고 생각했습니다. 연결 중에 문제가 발견되었습니다. 개발 프로세스 중에 인터페이스가 변경되었습니다. Swagger가 수정되었지만 MockJs는 제때에 수정되지 않았습니다. 백엔드에서 개발한 인터페이스 데이터 유형과 문서가 일관성이 없어 육안으로 문제를 발견하기가 어렵습니다. 마찬가지로 JMeter로 작성된 테스트 케이스도 실제로 실행될 때 다양한 불일치를 발견합니다. 시간이 지남에 따라 다양한 불일치가 점점 더 심각해질 것입니다.

Apifox 솔루션:

다운로드 주소

1. 이러한 문제를 해결하는 방법

1. Apifox 포지셔닝

Apifox = Postman + Swagger + Mock + JMeterApifox는 API 문서입니다. , API Mock, API 자동화 테스트 통합 협업 플랫폼입니다.

하나의 시스템, 하나의 데이터를 통해 여러 시스템 간의 데이터 동기화 문제를 해결하세요. 인터페이스 문서가 정의되어 있으면 인터페이스 디버깅, 데이터 모킹, 인터페이스 테스트를 다시 정의하지 않고도 인터페이스 문서와 인터페이스 개발 및 디버깅에 동일한 도구를 사용할 수 있습니다. 인터페이스 문서 정의와 완전히 일치하도록 보장됩니다. 효율적이고 적시에 정확합니다!

2. Apifox의 목적

R&D팀의 모든 순간을 절약하세요!

3.Apifox 기능

인터페이스 디자인: Apifox 인터페이스 문서는 OpenApi 3.0(이전 Swagger) 및 JSON 스키마 사양을 따르지만 학습 비용 없이 매우 사용하기 쉬운 시각적 문서 관리 기능을 제공하며 매우 효율적입니다. 그리고 온라인으로 인터페이스 문서 공유를 지원합니다. 데이터 모델: 인터페이스 반환 데이터 구조 및 요청 매개변수 데이터 구조(JSON 및 XML 모드만 해당)를 정의할 때 직접 참조할 수 있는 재사용 가능한 데이터 구조입니다. 모델의 직접 중첩 참조, 직접 JSON/XML 지능형 가져오기를 지원하고 oneOf 및 allOf와 같은 고급 조합 모드를 지원합니다. 인터페이스 디버깅: Apifox에는 환경 변수, 사전/사후 스크립트, 쿠키/세션 전역 공유 등 Postman이 가지고 있는 기능이 있으며 Postman보다 더 효율적이고 사용하기 쉽습니다. 인터페이스 실행 후 Save as Use Case 버튼을 클릭하면 인터페이스 사용 사례가 생성됩니다. 매개변수 입력 없이 인터페이스 사용 사례를 직접 실행할 수 있어 매우 편리합니다. 사용자 정의 스크립트는 Postman 구문과 100% 호환되며 javascript, java, python, php, js, BeanShell, go, shell, ruby, lua 및 기타 언어 코드 실행을 지원합니다. 인터페이스 사용 사례: 일반적으로 인터페이스에는 올바른 매개변수 사용 사례, 잘못된 매개변수 사용 사례, 빈 데이터 사용 사례, 다양한 데이터 상태 사용 사례 등과 같은 여러 사용 사례가 있습니다. 인터페이스 사용 사례를 실행할 때 데이터 정확성이 자동으로 확인됩니다. 인터페이스 사용 사례를 사용하여 인터페이스를 디버깅하는 것은 매우 효율적입니다. 인터페이스 데이터 모의: 내장된 Mock.js 규칙 엔진은 다양한 데이터를 모의하는 데 매우 편리하며, 데이터 구조를 정의하면서 모의 규칙을 작성할 수 있습니다. 요청 매개변수를 기반으로 다양한 모의 데이터를 반환하는 "기대" 추가를 지원합니다. 가장 중요한 것은 Apifox가 아무런 구성 없이도 매우 사용자 친화적인 데이터를 모의할 수 있다는 점입니다. 이에 대해서는 이 기사의 뒷부분에서 소개하겠습니다. 데이터베이스 작업: 데이터베이스 데이터 읽기 및 이를 인터페이스 요청 매개변수로 사용하는 것을 지원합니다. 인터페이스 요청이 성공했는지 확인(어설션)하기 위해 데이터베이스 데이터 읽기를 지원합니다. 인터페이스 자동화 테스트: 인터페이스 컬렉션 테스트를 제공하며, 인터페이스(또는 인터페이스 사용 사례)를 선택하여 테스트 세트를 빠르게 생성할 수 있습니다. 현재 인터페이스 자동화 테스트를 위한 더 많은 기능이 아직 개발 중이므로 계속 지켜봐 주시기 바랍니다! 목표는 JMeter가 기본적으로 모든 기능을 갖추고 사용하기 쉬워야 한다는 것입니다. 빠른 디버깅: Postman과 유사한 인터페이스 디버깅 방법으로, 문서화가 필요하지 않은 일부 인터페이스를 일시적으로 디버깅하는 것이 주요 목적입니다. 인터페이스를 미리 정의하지 않고도 빠르게 디버깅할 수 있습니다. 코드 생성: 인터페이스 및 데이터 모델의 정의를 기반으로 시스템은 인터페이스 요청 코드, 프런트엔드 비즈니스 코드 및 백엔드 비즈니스 코드를 자동으로 생성합니다. 팀 협업: Apifox는 팀 협업을 위해 탄생했습니다. 인터페이스는 클라우드에서 실시간으로 동기식으로 업데이트되며 성숙한 팀/프로젝트/구성원 권한 관리는 모든 유형의 기업의 요구를 충족합니다.

2. Apifox는 단순한 데이터 통합 ​​이상의 역할을 합니다

Apifox가 R&D팀의 효율성을 높이기 위해 데이터 통합만 한다고 생각한다면 착각입니다. Apifox는 또한 개발자 효율성을 높이기 위해 많은 혁신을 이루었습니다.

1. 인터페이스는 "사용 사례 관리"를 지원합니다.

일반적으로 인터페이스에는 올바른 사용 사례, 잘못된 매개 변수 사용 사례, 빈 데이터 사용 사례 및 다양한 데이터 상태 사용 사례와 같은 여러 사용 사례가 있습니다. 인터페이스를 정의할 때 다양한 상태에 대해 이러한 사용 사례를 정의하고 인터페이스를 디버깅할 때 직접 실행하면 매우 효율적입니다.

2. "데이터 모델" 정의 및 참조

데이터 모델은 인터페이스 정의 시 직접 참조할 수 있으며, 데이터 모델도 서로 참조할 수 있습니다. 동일한 데이터 구조는 한 번만 정의하고 여러 위치에서 사용하면 됩니다. 수정 시 한 위치만 수정하면 불일치를 방지하기 위해 여러 위치가 실시간으로 업데이트됩니다.

3. 디버깅 중 데이터 구조를 "자동으로 확인"

Apifox 디버깅 인터페이스를 사용할 때 시스템은 시각적인 필요 없이 인터페이스 문서의 정의에 따라 반환된 데이터 구조가 올바른지 자동으로 확인합니다. 인식 또는 탐지를 위한 어설션 스크립트를 수동으로 작성하는 것이 매우 효율적입니다!

Apifox는 자동으로 데이터 구조를 확인합니다

4. "시각화" 어설션 설정

어설션 설정:

Apifox 어설션 설정

실행 후 어설션 결과 보기:

5. "시각화 " 추출 변수 설정

6. 데이터베이스 운영 지원

7. "제로 구성" Mock은 매우 사용자 친화적인 데이터를 생성합니다

먼저 제로 구성 모의를 비교하기 위해 그림을 넣어 보겠습니다. Apifox 및 기타 유사한 도구의 결과 데이터 효과:

Apifox Mock 데이터 결과는 유사한 도구와 비교됩니다.

Apifox 제로 구성 Mock에서 생성된 데이터가 실제 상황과 매우 유사하다는 것을 알 수 있습니다. 프런트엔드 개발자는 모의 규칙을 수동으로 작성하지 않고도 직접 사용할 수 있습니다.

Apifox가 높은 효율성과 제로 구성으로 매우 사용자 친화적인 모의 데이터를 생성하는 방법

Apifox는 인터페이스 정의의 데이터 구조와 데이터 유형을 기반으로 모의 규칙을 자동으로 생성합니다. Apifox에는 필드 이름과 필드 데이터 유형을 기반으로 자동 생성된 모의 규칙을 지능적으로 최적화하는 지능형 모의 규칙 라이브러리가 내장되어 있습니다. 예를 들어, 이름에 image라는 문자열이 포함된 문자열 유형 필드는 이미지 주소 URL을 자동으로 모형화합니다. time 문자열이 포함된 문자열 유형 필드는 city 문자열을 포함하는 문자열 유형 필드를 자동으로 모형화합니다. 도시 이름. 내장된 규칙을 기반으로 Apifox는 사진, 아바타, 사용자 이름, 휴대폰 번호, 웹사이트 주소, 날짜, 시간, 타임스탬프, 이메일 주소, 지방, 도시, 주소, IP 등과 같은 필드를 자동으로 식별하여 조롱할 수 있습니다. 매우 사용자 친화적인 데이터입니다. 내장된 모의 규칙 외에도 사용자는 다양한 개인 요구 사항을 충족하기 위해 규칙 라이브러리를 사용자 정의할 수도 있습니다. 필드 이름을 사용자 정의 모의 규칙과 일치시키기 위해 정규식 및 와일드카드 사용을 지원합니다.

8. 온라인 인터페이스 문서 생성

Apifox 프로젝트는 API 문서를 온라인으로 "공유"할 수 있으며, 공유된 API 문서는 공개로 설정하거나 비밀번호 액세스를 요구할 수 있어 외부 팀과의 협업에 매우 편리합니다.

체험 주소: https://www.apifox.cn/apidoc/shared-ce387612-cfdb-478a-b604-b96d1dbc511b/http/5041285

9. 에 따르면 인터페이스 모델 정의, 자동으로 비즈니스 코드(예: 모델, 컨트롤러, 단위 테스트 코드 등) 생성 및 다양한 언어/프레임워크(예: TypeScript, Java, Go, Swift, ObjectiveC, Kotlin, Dart, C++, C#)로 인터페이스 요청 생성 , Rust 등) 코드. Apifox는 현재 130개 언어 및 프레임워크에 대한 자동 코드 생성을 지원합니다.

더 중요한 점: 맞춤형 코드 템플릿을 사용하여 팀의 아키텍처 사양에 맞는 코드를 생성하여 다양한 개인화된 요구 사항을 충족할 수 있습니다.

10. 가져오기, 내보내기

OpenApi(Swagger), Markdown, Html 및 기타 데이터 형식 내보내기를 지원하므로 OpenApi(Swagger)의 풍부한 생태 도구를 사용하여 다양한 인터페이스를 완성할 수 있습니다. 관련 업무가 중요합니다. OpenApi(Swagger), Postman, apiDoc, HAR, RAML, RAP2, YApi, Eolinker, NEI, DOClever, ApiPost, Apizza, ShowDoc, API Blueprint, I/O Docs, WADL, Google Discovery 및 기타 데이터 형식 가져오기를 지원하여 이전 버전을 쉽게 사용할 수 있도록 합니다. 프로젝트가 마이그레이션됩니다. OpenApi(Swagger), apiDoc 및 Apifox 형식 데이터의 예약된 자동 가져오기를 지원합니다.

3. 후속 기능 계획

Apifox WEB 버전을 출시하여 브라우저 측에서 Apifox 사용을 지원합니다. 인터페이스 성능 테스트 지원(JMeter와 유사) 플러그인 시장을 지원하며, 플러그인을 직접 개발할 수 있습니다. 개발자가 API를 통해 Apifox 기능을 호출할 수 있도록 Apifox API를 엽니다. GraphQL, gRPC, websocket 등과 같은 더 많은 인터페이스 프로토콜을 지원합니다. 오프라인 사용을 지원합니다. 프로젝트는 온라인으로 동기화하거나(팀 협업을 위해) 로컬에만 저장할 수 있습니다(단일 컴퓨터에서 오프라인으로 사용하기 위해).

4. 더 많은 Apifox 기능 스크린샷

인터페이스 디버깅

사용자 정의 모의 규칙

스마트 모의

인터페이스 자동화

프로젝트 가져오기

프로젝트 내보내기

다중 선택할 수 있는 테마

5. Apifox 다운로드 주소

Apifox의 수많은 실용적인 기능을 소개하니 사용하면 정말 이득이 됩니다! 소프트웨어는 완전 무료이며 관심이 있고 필요한 친구는 아래 링크를 직접 복사하여 브라우저에 붙여넣고 열어 다운로드하거나 클릭하여 원본 텍스트를 직접 읽을 수 있습니다! 공식 홈페이지 주소 :

https://www.apifox.cn/