Optic으로 API 개선

API 개발자 또는 API 소비자라면 계약을 항상 최신 상태로 유지하는 것이 얼마나 중요한지 알고 계실 것입니다. 뭔가를 변경하고 계약서를 업데이트하지 않으면 어딘가에서 누군가 화를 냅니다 😡 !

그래서 여기 API 소비자와 친구가 되는 데 도움이 되는 도구가 있습니다 👫 .

뭐?

Optic은 "API 계약을 위한 Git과 유사한 버전 제어 시스템"입니다. API 문서를 작성하고 API 요청 및 응답을 즐겁게 변경할 때 업데이트하기가 더 쉬워집니다. 변경 사항을 검토하고 승인하기만 하면 됩니다.

설치

CLI를 npm 글로벌 패키지로 설치하거나 homebrew를 사용하여 설치할 수 있습니다.

Java, NodeJS, Go, Rust 등 대부분의 언어에서 작동합니다.

어떻게?

Optic은 프록시를 사용하여 네트워크를 통해 API를 모니터링합니다. API의 모든 변경 사항을 감지하고 API 설명서의 변경 사항을 제안합니다.

프로젝트의 루트로 이동하여 다음을 실행합니다.
api init


이렇게 하면 프로젝트에 optic.yml가 생성되어 몇 가지 항목으로 이동하고 업데이트할 수 있습니다.

command - API 프로젝트를 실행하는 명령입니다. 또한 서버 포트를 $OPTIC_API_PORT로 설정해야 합니다. 이것은 Maven Java 프로젝트의 샘플입니다.

export SERVER_PORT=$OPTIC_API_PORT; mvn exec:java -Dexec.mainClass="com.test.Application"`

inboundUrl - API 호스트 이름 및 포트입니다. 좋아요 http://localhost:8080

그런 다음 구성이 제대로 작동하는지 확인하는 방법이 있습니다.
api check start . check 접두사는 구성을 확인한 다음 start API를 시작합니다.



API 개발자를 돕는 몇 가지 다른 명령이 있습니다.

api 생성 - 이렇게 하면 Open API 문서가 생성되어 어딘가에서 호스팅하고 Readme, Swagger UI, Slate 등과 같은 UI로 사용할 수 있습니다.

api 사양 - 브라우저에서 Optic API 사양을 엽니다

.

샘플 Spring Boot Ping API를 생성하고 문서에 따라 설정했습니다. 몇 분 만에 시작하고 실행했는데 바로 엔드포인트를 찾고 문서를 제안했습니다.



모든 API 개발자에게 이것은 API가 개발되는 동안 API를 문서화하고 변경 사항이 있을 때 최신 상태로 유지해야 하는 주요 문제를 해결합니다. 그리고 코드를 작성하는 동안 로컬 트래픽을 스누핑하여 그렇게 합니다!

내가 그것을 좋아하는 이유!

GitBot - 당신을 위해 모든 문서를 작성하는 것 외에도 모든 Pull 요청에 대해 설명하고 API의 변경 사항을 감지하고 PR에 설명하는 github 통합이 있습니다! 검토자가 수정한(또는 깨진) 내용을 확인할 수 있습니다.

보세요 엄마, YAML이 없습니다! - (거의) yaml이 몇 줄만 작성하면 됩니다. 다른 모든 Open API 사양은 멋진 문서를 얻을 수 있도록 해 줍니다.

API 테스트 커버리지 - Newman을 통해 테스트를 실행하기 위한 통합을 통해(optic.yml에서 작업을 정의해야 함), --collect-coverage 플래그를 사용하여 Optic에 API 테스트 코드 커버리지를 추적하고 이를 보고하도록 요청할 수 있습니다. API 문서 응답을 살펴보고 테스트를 작성하지 않은 응답을 강조 표시합니다. 따라서 더 이상 API 자동화 테스트에서 엣지 케이스를 잊지 마세요!

결론

API를 개발하는 모든 회사에서 잠재적으로 많이 사용할 수 있고 변경 사항을 추적해야 하는 훌륭한 도구라고 생각합니다. 빌드 파이프라인에 추가하고 CI 파이프라인에서 해당 코드 적용 범위 도구를 사용할 수 있습니다. 광고할 때 API에 대한 소스 제어와 확실히 같습니다.

또한 무료이며 오픈 소스입니다. 따라서 repohere를 포크할 수 있습니다.