api 문서 예제

III: API 끝점 문서화: API 끝점에 대한 참조 문서는 리소스 설명, 끝점 및 메서드, 매개 변수, 샘플 요청, 샘플 응답 및 스키마의 다섯 가지 일반 섹션으로 구성됩니다. API의 참조 끝점을 문서화하려면 이러한 각 섹션에 대한 자세한 정보를 제공합니다. 문서에 대한 레이아웃을 실험하려면 일부 무료 및 오픈 소스 API 문서 생성기를 체크 아웃할 수 있습니다. 전체 화면은 StormPath의 문서 홈 페이지에 있는 언어 옵션으로 채워져 있습니다. 각 언어 뒤에는 빠른 시작, 전체 설명서, API 참조, GitHub 프로젝트 등이 있는 페이지가 있습니다. 이러한 각 리소스는 언어 또는 프레임워크에 따라 다릅니다. 이 코스의 일부 코드 샘플에서는 자바스크립트를 사용합니다. JavaScript는 REST API를 문서화할 때 실제로 사용하는 언어일 수도 있고 아닐 수도 있지만, 알아야 할 중요한 프로그래밍 언어 나 플랫폼이 있을 가능성이 큽니다. 독자에게 유용한 상호 참조를 포함하려면 생성된 설명서 내에서 이러한 부분에 대한 하이퍼링크를 연결할 수 있습니다. 팀원과의 상호 작용을 저장하고, 다른 곳에 맞지 않는 정보를 추가하고, 토론 등을 할 수 있습니다. Stripe는 개발자에게 엄청난 노력을 기울였지만, 이것이 바로 결제 회사가 훌륭한 문서 경험을 제공하는 데 있어 가장 높은 순위에 이름을 올린 이유이기도 합니다. 이 방법은 모든 사용자가 사용할 수 없는 경우가 많지만, 마찰을 줄이고 개발자가 API를 쉽게 시도할 수 있는 방법을 찾는 것이 좋습니다. 편집자는 문법 실수, 오류 및 읽기 어렵거나 이해하기 어려운 부분을 잡기 위해 문서를 교정해야 합니다.

또한 스타일 가이드에 대해 기술 문서를 확인하고 필요한 경우 변경 사항을 제안해야 합니다. 만화 회사 마블의 주요 문서는 대화형입니다. API 키가 있으면 양식에 요청 필드를 작성하고 “Try Out!” 버튼을 클릭하여 호출을 테스트할 수 있습니다. 응답 JSON은 응용 프로그램에서 수신할 것과 동일한 데이터를 반환할 때 양식 아래에 표시됩니다. Clearbit 문서는 쉽게 찾아볼 수 있습니다. 그것은 하나의 페이지에 있기 때문에, API 참조의 큰 기능, 그것은 Ctrl + F /Cmd + F 수. 즉, 브라우저의 찾기 기능을 사용하여 검색할 수 있습니다. 모든 섹션은 스크롤할 때 확장되는 왼쪽 탐색에 자세히 설명되어 있습니다.

02 August, 2019
Posted in Uncategorized

Author: wolff