Lamao LiveAPI에서: 매우 편리한 API 문서 작성(2부)-JS 튜토리얼-php.cn

Lamao LiveAPI에서: 매우 편리한 API 문서 작성(2부)

Barbara Streisand

풀어 주다： 2024-12-16 08:21:16

원래의

404명이 탐색했습니다.

이전 게시물에서 저는 파트타임으로 일하는 학생들로 구성된 소규모 팀이 API 수집 및 실행을 단순화하는 도구인 Lama2를 구축한 방법을 공유했습니다.

이는 빠르게 우리 워크플로의 필수적인 부분이 되었지만 API 저장소가 성장함에 따라 Lama2의 수동 프로세스에는 한계가 나타나기 시작했습니다.

처음 시작했을 때 우리 팀은 아르바이트와 학업을 병행하는 5명의 학생으로 구성되었습니다.

우리는 매일 3~4시간씩 일하면서 종종 제한된 능력의 한계를 뛰어넘었습니다. Lama2는 당시 우리가 만들고 있던 세 가지 프로젝트 중 하나에 불과했습니다.

우리의 제약에도 불구하고 Lama2는 Hacker News에서 좋은 반응을 얻었습니다. 우리는 제품에 대한 초기 지지자들도 얻었습니다. CLI 도구와 틈새 언어의 경우 확실한 반응이었습니다.

그러나 배송 기능은 여전히 우리가 기대했던 것보다 더 오래 걸렸습니다. 우리가 경쟁할 준비가 되었을 때 API 클라이언트 시장은 이미 혼잡했습니다.

유사한 제품에 대해 정규직으로 일하는 기존 팀은 열심히 일하고 봉사 활동을 통해 관심을 얻었습니다. Lama2는 실제 문제를 해결했지만 우리가 상상했던 광범위한 소문을 불러일으키지는 못했습니다.

Lama2가 실질적인 영향을 미치려면 단순한 실행 도구 이상의 것이 필요하다는 것을 깨달았습니다.

처음 시작했을 때 우리 팀은 아르바이트와 학업을 병행하는 5명의 학생으로 구성되었습니다.

그러나 배송 기능은 여전히 우리가 기대했던 것보다 더 오래 걸렸습니다. 우리가 경쟁할 준비가 되었을 때 API 클라이언트 시장은 이미 혼잡했습니다.

Lama2가 실질적인 영향을 미치려면 단순한 실행 도구 이상의 것이 필요하다는 것을 깨달았습니다.

수동 API 문서화의 문제점

Lama2를 사용하더라도 대규모 API 컬렉션을 유지하는 것은 어려운 일이었습니다. 처음에는 모든 서비스에 대해 단일 저장소에 API를 수집하는 것이 관리하기 쉽다고 느꼈습니다. 하지만 4개의 백엔드와 수백 개의 API로 확장하면서 프로세스가 너무 힘들어졌습니다.

우리는 API 변경 사항을 수동으로 문서화하고 동기화하는 것이 얼마나 불편한지 직접 알고 있었습니다. 그리고 우리는 혼자가 아니었습니다. 모든 개발자는 대규모 API 컬렉션을 처리할 때 이러한 문제에 직면합니다.

우리는 워크플로를 자동화하여 API 문서화를 쉽게 만들고 원활하게 실행해야 한다는 것을 알고 있었습니다. 우리의 목표는 수동 단계를 제거하고 다음을 수행할 수 있는 도구를 만드는 것이었습니다.

우리의 목표는 간단했습니다. "매우 편리한 API 문서화"

다음과 같은 시스템을 상상해 보세요.

From Lamao LiveAPI: Building Super-Convenient API Documentation (Part II)

이 비전을 실현하기 위해 우리는 다음과 같은 주요 기능으로 설계된 플랫폼인 LiveAPI 개발을 시작했습니다.

원클릭 저장소 연결: 개발자는 GitHub, GitLab 또는 Bitbucket 저장소를 손쉽게 연결할 수 있습니다.
자동 문서 생성: 문서는 모든 커밋에 대해 자동으로 생성되며 자동 동기화를 통해 최신 상태로 유지됩니다.
자동 코드 조각: 모든 언어에 대한 코드 조각을 생성하여 프런트엔드 개발자가 더 빠르게 작업할 수 있도록 합니다.
개발자 친화적인 경험: 최소한의 설정으로 최대한의 편의성을 제공합니다.
개인정보 보호를 최우선으로 하는 LiveAPI Runner:
- 저희는 저장소의 코드를 절대 저장하지 않습니다.
- 저희 로직을 사용하여 경로와 API 유효성 검사기만 추출합니다.
- 이 전체 프로세스는 개인 서버에서 실행되므로 데이터가 인프라를 벗어나지 않습니다.