API 명세서

·2023년 9월 15일
0

Project

목록 보기
3/5
post-thumbnail

API

  • 애플리케이션이 어떤 프로그램이 제공하는 기능을 사용할 수
    있게 만든 매개체
  • 서버는 자신이 제공하고자 하는 데이터나 기능을 API로 만들면,
    프로그래머나 프로그램이 API를 통해 서버에게 제공하는 데이터를
    요청해서 사용할 수 있게 된다

정적 방법 제외하고는 2가지

  • MVC 방식으로 html을 웹브라우저에 넘겨주는 방법

  • API를 주는 방법
    : html에 바디 태그가 아닌, http에 바디부에 내가 원하는 데이터를
    직접 넣어주겠다.
    : 템플릿과 다르게 html 태그가 하나도 없다.

  • 데이터를 반환할 때 씀
    그렇다면 JSON 쓰는 이유?
    -> 앱<->서버, 자바<->자바스크립트 처럼 이기종 간의 데이터 교환이 목적이다.
    -> 텍스트 데이터 표현을 위한 간결하고 가독성 높은 형식이기
    때문이다.

Swagger로 API를 작성하려고 하는 와중에 컨트롤러로만 작성된 코드가 rest api 형태로 바꿔야 한다는 문제가 생겼다.

  1. 문제: rest api가 뭔데??
    ->

  2. 문제: Controller 어노테이션 -> restController로 바꿔야한다.
    A. restController 이용하기 위해서는 버전이 4.x.x 이상이어야 해서
    Controller+ResponseBody를 이용해서 짜야겠다!

  3. 회원가입 프로젝트를 restful api로 설계하기 위해서 Controller말고도 비즈니스
    로직을 수행하는 서비스 클래스인 MemberService 클래스도 RosponseEntity를
    반환하도록 해야해?

A. memberservice 클래스에서는 비즈니스 로직을 처리하고 그 결과를 DTO 객체로 반환하거나,
필요한 경우 예외를 던지는 방식으로 비즈니스 로직을 처리하기 때문에
일반적으로 'ResponseEntity'를 직접 반환하진 않는다.

profile
기회를 잡기 위해 준비하자 !

0개의 댓글