본문 바로가기

API-First Design4

4. Gradle 프로젝트에서 Swagger Codegen 적용하기. SwaggerCodeGen CLI 에 대한 설명은 이전에 했었습니다. 이제부터는 Gradle 프로젝트에 SwaggerCodegen을 적용하는 방법에 대해서 알아보겠습니다. 먼저 Gralde SwaggerCodegen Plugin 을 알아야 합니다. 저 또한 여기 나온 메뉴얼대로 진행했습니다. 당연히 우선적으로 행해져야 하는 부분은 의존성을 추가하는거겠죠? plugins { id 'org.hidetake.swagger.generator' version '2.18.2' } repositories { jcenter() } dependencies { swaggerCodegen 'io.swagger:swagger-codegen-cli:2.4.2' // Swagger Codegen V2 swaggerCodegen .. 2020. 10. 18.
3. Swagger CodeGen CLI 는 무엇인가? API First Design 를 외치면서 활용했던 도구로, Swagger Codegen CLI를 활용했습니다. 해당 도구를 활용한 프로젝트 소스코드는 여기를 참조해주시면 됩니다. Swagger Codegen CLI은 OPEN API Spec을 기반으로, Yaml 파일로 어떤 API 를 Request 하고 Response 할 지 정의를 해놓으면, Swagger Codegen CLI은 정의해놓은 Yaml 파일을 통해, 각 클라이언트에서 사용되는 통신 라이브러리를 활용해 코드를 생성해줍니다. 이는 개발자로 하여금, 개발의 편의성을 한껏 높일 뿐만아니라, 어떤 API를 사용하고 있는지에 대해서 변경되어야 하는 부분은 유연하고, 신속하게 대응할 수 있고, 개발자가 구현해야 되는 부분은 최소화로 만들어줍니다. 이.. 2020. 10. 18.
2. Swagger을 소개합니다. 들어가기 이전에 API First Design 설계에 대한 내용을 다뤄봤습니다. API First Design 을 실천할 수 있는 도구들은 다양하게 있습니다. 그 중에서 저는 오픈소스 Swagger 를 선택했습니다. 그렇다면 Swagger 가 무엇인지 간단하게 알아볼 필요가 있을 것 같아, 이렇게 소개하는 포스팅을 합니다. Swagger의 메인 페이지를 들어가면, 여기서 우리는 Swagger의 철학을 이해할 수 있습니다. Swagger의 오픈 소스를 사용해, 사용자, 팀 및 기업을 위한 API 개발을 단순화하세요. 메인 페이지에 나타낸만큼 Swagger 는 API 를 설계하기 위한 다양한 도구를 제공해줍니다. 그 도구들은 아래와 같습니다. 여기서 SwaggerHub는 클라우드 상에 아래 Swagger E.. 2020. 9. 30.
1. API First Design 설계의 선순환 들어가기 Slipp 에서 사이드 프로젝트를 진행하면서 API First Design 설계 라는 용어를 처음 접하게 됐습니다. 그리고 API First Design을 실천하기 위해 고군분투했던 내용들을 정리하면 좋을 것 같아 이렇게 내용을 내려적습니다. 아래 내용은 다우기술 전사 세미나에서 제가 발표했던 내용입니다. 슬라이드는 여기있습니다. 1. API First Design 이란 무엇을 의미하는 걸까요? "협업하는 개발 프로세스에서 API를 첫 번째 우선 순위로 가져가는 것." 위 그림은 로버트 C 마틴이 클린아키텍쳐에서 말하길, 약 8번의 릴리즈를 하면 처음보다 약 40배의 비용이 들어간다는 것을 말하는 그래프입니다. 우리가 운영하고, 서비스하는 회사들의 대부분은 위와같은 형태를 따릅니다. 제가 근무하.. 2020. 9. 30.