API Blueprint
API Blueprint는 웹 API를 위한 강력한 고급 API 설명 언어입니다. API Blueprint는 API 생명 주기에 관련된 모든 사람에게 간단하고 접근 가능합니다. 그 문법은 간결하면서도 표현력이 뛰어납니다. API Blueprint를 사용하면 신속하게 API를 설계하고 프로토타입을 만들거나, 이미 배포된 미션 크리티컬 API를 문서화하고 테스트할 수 있습니다.
협업에 중점을 둔 API Blueprint
API Blueprint는 프로젝트 이해 관계자, 개발자 및 고객 간의 대화와 협업을 장려하도록 설계되었습니다. 동시에 API Blueprint 도구는 API 개발, 거버넌스 또는 배포와 같은 목표를 달성하는 데 필요한 지원을 제공합니다.
오픈 소스
API Blueprint는 MIT 라이센스 하에 완전히 오픈 소스입니다. 그 미래는 투명하고 개방적입니다. API Blueprint는 폐쇄된 작업 그룹이 필요하지 않습니다. 대신 Rust 언어 또는 Django 개선 제안 RFC 프로세스와 유사한 RFC 프로세스를 사용합니다. 기여하려면 API Blueprint RFC 저장소에 제안서를 제출하세요.
GitHub에서의 API Blueprint
API Blueprint 언어는 GitHub에서 인식됩니다. GitHub에서 "API Blueprint" 언어를 사용하여 API Blueprint를 검색하세요. API Blueprint의 미디어 타입은 text/vnd.apiblueprint이며, 표준 파일 확장자는 .apib입니다. 이 확장자를 사용하면 GitHub에서 문서가 구문 강조 표시됩니다.
더 나은 API 디자인을 위한 API Blueprint
API Blueprint는 추상화를 통해 더 나은 API 디자인을 장려하도록 설계되었습니다. API Blueprint의 목표는 API의 요소를 분리하여 모듈성을 가능하게 하면서 백엔드 구현 동작을 캡슐화하는 것입니다. 예를 들어, 데이터 설명 문법을 사용하여 먼저 데이터를 모델링합니다.
데이터 구조
블로그 게시물 (객체)
- id: 42 (숫자, 필수)
- text: Hello World (문자열)
- author (저자) - 블로그 게시물의 저자.
저자 (객체)
- name: Boba Fett
- email:
그런 다음 API 엔드포인트에서 데이터를 사용하고 재사용합니다.
블로그 게시물 [/posts]
모든 게시물 검색 [GET]
- 응답 200 (application/json)
- 속성 (array[블로그 게시물])
디자인 우선 API Blueprint
API Blueprint는 디자인 우선 철학에 관한 것입니다. 테스트 주도 개발의 테스트와 유사하게, API Blueprint는 API에 대한 계약을 나타냅니다. API를 논의하고 개발되기 전에 계약을 정하는 것은 더 나은 API 디자인으로 이어지는 경향이 있습니다. API Blueprint가 설정되면 모든 사람이 구현이 계약에서 설정된 기대를 충족하는지 테스트할 수 있습니다.
멋진 도구들
폭넓은 채택 덕분에 API Blueprint를 위한 다양한 도구들이 존재합니다. 모의 서버, 문서화 및 테스트 도구와 같은 다양한 독립형 도구부터 전체 기능을 갖춘 API 생명 주기 솔루션까지 포함됩니다. 도구 섹션에서 목록을 확인하세요.
시작하기
API Blueprint를 시작하려면 일반 텍스트 편집기가 필요합니다. 최상의 편집 경험을 위해 문법 강조를 Markdown 또는 API Blueprint로 전환하세요(편집기에서 지원되는 경우). 편집기가 준비되면 API Blueprint 튜토리얼을 따르세요. 첫 번째 API Blueprint를 작성한 후 친구들과 API 디자인을 논의하고 API Blueprint 도구를 사용하세요. 예를 들어, 문서를 렌더링하거나 서비스의 모의를 생성하거나 백엔드 구현을 테스트하는 데 사용할 수 있습니다. API Blueprint 문법에 대한 추가 리소스는 문서 섹션을 확인하세요.
