API
는 소프트웨어나 시스템간에서 서로 정보를 교환하기 통신할 수 있게 해주는 도구나 프로토콜 모임임.
- API를 통해 개발자들은 다양한 서비스나 데이터를 쉽게 사용할 수 있음.
API의 구성 요소
- HTTP Method
- HTTP Path
- 쿼리 (key, value)
- API의 반환 결과
- API를 개발하기 전에는 API의 메소드, 패스를 어떻게 할 것인지, 쿼리를 사용할 것인지 바디를 사용할 것인지, 쿼리를 사용한다면 어떤 Key를 사용할 것인지, 결과는 어떤 형태로 줄 것인지를 고민해서 결정해야 함
- 위 사항을
API Specifiaction(명세)
줄여서 API 스팩
이라고 한다
GET API
덧셈 API 예시
*@RestController
public class CalculatorController {
@GetMapping("/add")
public int addTwoNumbers(
@RequestParam int number1,
@RequestParam int number2
){
return number1 + number2;
}
}*
@RestController
: 주어진 클래스를 컨트롤러로 등록 (컨트롤러 : API의 진입 지점)
@GetMapping("/add")
: 아래에 있느 함수를 HTTP Method가 GET, HTTP Path가 /add 인 API로 지정
@RequestParam
: 주어지는 쿼리를 함수 파라미터에 넣는다