API를 쉽게 이해, 구현 및 유지 관리 할 수 있도록 품질 문서가 중요합니다. 우리는 가장 널리 사용되는 API 시각화 도구 중 하나 인 Swagger UI와 Redoc을 사용하여 OpenAPI 사양을 기반으로 자동 생성 문서를 설정했습니다.
이를 통해 개발자에게 방법 구조를 배우고 쿼리를 테스트하며 API에 빠르게 연결할 수있는 대화 형 인터페이스를 제공 할 수 있습니다.
문서에 포함 된 내용
| 섹션 | 설명 |
|---|---|
| 엔드 포인트 및 방법 | 전체 경로 목록, 맞춤법, 매개 변수, 헤더 |
| 샘플 요청/응답 | 컬, 우편 배달부, 자바스크립트, 파이썬 및 기타 언어에 대한 스크립트 |
| @ info: whatsthis | 인터페이스에서 직접 JWT, OAuth2, API 키 지원 |
| 시설 다이어그램 | 모델, 중첩 구조 및 데이터 요구 사항에 대한 설명 |
| 오류 코드 | 설명과 함께 가능한 모든 상태 |
우리가 사용하는 도구
Swagger UI-테스트 기능이있는 브라우저의 대화식 문서- Redoc은 사이트에 게시하기에 이상적인 읽기 쉽고 정적 인 인터페이스입니
- OpenAPI 3. 0/3. 1-모든 것이 구축되는 사양의 형식
- 코드에서 자동 생성-주석, 설명, 버전 및 문서 업데이트 자동
- JSON/YAML/HTML로 내보내기
팀 및 파트너를위한 혜택
새로운 개발자의 온 보딩 가속화- 통합 오류 감소
- 항상 최신 코드 동기화 문서
- 기술 지원없이 빠른 통합 시작
- 공개 또는 개인 포털에 대한 문서의 간단한 게시
특히 중요한 곳
외부 개발자를위한 API 열기- 활성화 된 내부 API
- B2B 통합 및 SDK가있는 플랫폼
- 규정 및 체계 검증 요구 사항이있는 서비스
Swagger와 Redoc은 차세대 API 문서 표준입니다. 모든 개발자가 몇 분 안에 API와 통합을 시작할 수 있도록 문서의 생성, 업데이트 및 게시를 설정합니다.
인기 주제
주요 주제
문의하기
아래 양식을 작성해주시면 최대한 빨리 답변드리겠습니다.