취미 API 수집 및 실행 도구가 어떻게 제품으로 진화하고 있는가

모든 스타트업에서 여러 서비스에 걸쳐 API를 관리하는 것은 일반적인 과제입니다.

우리는 세 가지 주요 문제에 직면했습니다.

1. API 문서화
2. 문서 게시
3. API가 변경될 때마다 업데이트

각각의 질문은 다음과 같습니다. 어떻게 수행할지, 어디서 수행할지, 사용할 도구는 무엇인지, 누가 소유권을 갖게 될지.

이 문제를 해결하기 위해 우리 팀은 모든 API를 APIHub라는 단일 저장소에 통합하기로 결정했습니다. 각 서비스의 API는 간단하고 일관된 형식으로 저장되었습니다.

GET | POST | PUT | DELETE | PATCH  
${baseurl}/endpoint  
{  
  "body": "if present"  
}

기능에 따라 파일 이름을 지정했습니다. 다음은 저장소의 다른 API를 보여주는 사이드바와 함께 "Leave Apply" API에 대한 .l2 파일의 예입니다.

문서화 관행 개선

모든 풀/병합 요청에 해당 .l2 파일을 포함하도록 의무화했습니다. 그렇지 않은 경우 요청이 승인되지 않습니다. 이 간단한 규칙은 팀 전체에서 API 문서의 일관성을 높였습니다.

문서화부터 실행까지

우리는 URL과 페이로드를 Postman과 같은 도구에 복사하여 API를 수동으로 테스트하는 데 시간이 많이 걸린다는 사실을 곧 깨달았습니다. 그래서 Lama2라는 CLI 도구를 만들었습니다.

Lama2는 Git 기반 협업에 최적화된 일반 텍스트 API 관리자입니다.

Lama2를 사용하면 .l2 파일을 입력으로 전달할 수 있으며 CLI는 API를 실행하고 터미널에 응답을 표시합니다.

이를 통해 계속해서 복사하여 붙여넣는 수고를 덜었지만 .l2 파일을 찾기 위해 디렉터리를 전환하는 작업은 여전히 ​​지루했습니다.

lovestaco@i3nux:~/apihub/feedback/fb_v3/leave$ l2 apply_leave.l2  

VSCode로 가져가기

일을 더욱 간소화하기 위해 우리는 VSCode 확장을 개발했습니다. 작업 흐름을 더욱 원활하게 해주는 기능이 포함되어 있습니다.

1. 편집기에서 직접 .l2 파일 실행
2. 쉬운 공유를 위해 파일의 Git URL을 복사하세요.
3. JSON 페이로드 예쁘게 만들기
4. .l2 구문에서 모든 언어에 대한 코드 조각 생성
5. 새로운 API용 템플릿을 몇 초 안에 생성하세요
6. LSP를 이용한 변수 자동완성

이 확장 프로그램은 빠르게 팀 사이에서 인기를 얻었고 다른 사람들도 혜택을 누릴 수 있도록 GitHub에 출시하기로 결정했습니다.

다음 문제: 문서 확장

API가 성장함에 따라 우리는 스스로에게 다음과 같은 질문을 했습니다.

• 각 서비스의 API를 수동으로 문서화하는 이유는 무엇인가요?
• 변경할 때마다 문서를 업데이트하는 데 시간이 많이 걸리지 않나요?

여기서 우리 여행의 다음 장이 시작됩니다...
다음 게시물에서 다음에 무슨 일이 일어날지 알아보려면 저를 팔로우하세요.

위 내용은 취미 API 수집 및 실행 도구가 어떻게 제품으로 진화하고 있는가의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!