인생은 파도타기

OpenAPI 란? OpenAPI Specification 3.0 ( OAS ) 라고도 하며 이전 2.0버전까지는 Swagger 라는 도구로 더 유명하다. 아직까지도 Swagger (스웨거) 3 라거나 하는 경우도 종종 있는거같다. OpenAPI 는 RESTFul API를 명세화하거나 문서화 하기 위한 도구로 개발되었으며, 최소한의 구현으로 한눈에 API에 필요한 내용을 파악하기 위해 만들어지고 사용되고 있다. 즉, API를 문서화하기 위한 도구 라고 이해하는 것이 맞다. 그렇다면 왜 이런 도구가 필요해진걸까? 조금만 생각해보자면 현업에서 다양한 사람들과, 여러 클라이언트들에게 내가 혹은 우리회사가 만든 api 를 제공하거나 개발해야하는 경우가 많다. 이때, 이 api를 한눈에 보여주고 필요한 사항을 요..

개요 회사에서 업무중 몇가지 정보를 거래처에 제공하는 API를 만들어 줘야하는 경우가 생겼다. 기존의 주 업무는 Java - SpringBoot 프레임워크를 사용해서 했었지만, 이번에 새롭게 Golang 을 사용하는 건 어떤지 얘기가 나와서 고민하다가 결구 Go 언어로 새롭게 API를 개발해 보기로 했다. 먼저 Go 언어는 가볍고 미니멀한 프로젝트를 만들기에 적합하고, 비교적 다른언어보다 최근에 나온언어인지 웹 개발자들이 쓰기 좋은 기능들이 기본 내장되어 있는 듯했다. 일단 Web 통신을 위해 프레임워크나 라이브러리중 적합한 기능일 선택해야했는데, 1. 먼저 기본내장된 http/net, 2. github 순위 1위에 GIN 3. 그리고 한국에서 그나마 인기있다는 echo 이 3가지만 생각했고, 내장되어있..

개요 POST Method의 의미와 종류, 이를 활용하는 방법을 알아보기 POST Method란 리소스를 전달하여 추가하기 위해 사용되는 API로 Create를 위해 사용되는 Method이다. POST API의 종류 @PostMapping : POST API를 제작하기 위해 사용되는 어노테이션, @RequestMapping + POST method의 조합, 일반적으로 추가하고자 하는 Resource를 HTTP body에 추가해서 서버에 전달하여 요청, 그렇기에 @RequestBody 를 이용해 body값을 받음 DTO : key 와 value 가 정해져있지만, 받아야할 파라미터가 많을 경우 DTO객체를 사용하는 방식 // 1. postMapping @PostMapping(value="/member") ..

개요 API와 GET Method를 이해하고 활용하는 다양한 방법을 알아보기 GET 어노테이션의 종류 @RequestMapping : value와 method로 정의하여 API를 개발하는 방식으로 요즘 추세는 사용하지 않는 편 @GetMapping : 별도의 파라미터 없이 GET API를 호출하는 경우 사용되는 방법 @PathVariable : GET형식의 요청에서 파라미터를 전달하기 위해 URL에 값을 담아 요청하는 방법 @RequestParam : GET형식의 요청에서 쿼리 문자열을 전달하기 위해 사용되는 방법 // 1. ReqeustMapping @RequestMapping(value = "/hello", method = RequestMethod.GET) public String requestTes..

개요 REST API 란 무엇이며, 스프링부트에서 RESTful 한 API를 만들기위해 어떤방식으로 설계및 구현할지 알아보기위해 포스팅합니다. API 란? API는 Application Programming Interface의 줄임말로 응용 프로그램에서 사용할 수 있도록 다른 응용 프로그램을 제어할 수 있게 만든 인터페이스를 뜻합니다. API를 사용하면 내부 동작 로직을 알지못해도 정의되어 있는 기능으로 쉽게 사용할 수 있게됩니다. 여기서 Interface란 어떤 장치간에 정보 교환을 위한 수단이나 방법을 의미하며 대표적으로 마우스, 키보드 등이 해당됩니다. REST 란? REST는 Representational State Transfer 의 줄임말로 자원의 이름으로 구분하여 해당 자원의 상태를 교환하는..