REST API

Bam·2023년 2월 27일
0

자바

목록 보기
15/19

Representational State Transfer API
-> 대표 상태 전송 API (번역기)

HTTP를 사용하여 데이터를 주고받는 웹 서비스의 한 종류입니다. RESTful API라고도 불리며, 자원(Resource)을 URI로 표현하고, HTTP Method(GET, POST, PUT, DELETE 등)를 통해 자원을 처리하는 아키텍처 스타일입니다.

  • Stateless: 서버가 클라이언트의 상태를 저장하지 않습니다. 요청 간에 클라이언트의 상태 정보가 유지되지 않습니다.

  • Cacheable: 클라이언트는 응답을 캐시할 수 있습니다.

  • Uniform Interface: 리소스를 식별하는 데 사용되는 URI, 리소스 조작을 위한 HTTP Method, 리소스의 표현을 위한 미디어 타입 등의 인터페이스를 일관성 있게 설계합니다.

  • Layered System: 클라이언트는 서버에 직접 연결되는 대신, 중간 계층(로드 밸런서, 캐시 등)을 통해 연결됩니다.

  • Self-descriptive Messages: 요청과 응답은 메시지 자체가 스스로를 설명할 수 있어야 합니다.

    REST API를 사용하여 게시판의 글을 가져오는 API를 작성할 수 있습니다.

GET /boards/{board_id}/posts

{board_id}는 게시판의 ID를 나타냅니다. 이 API를 호출하면 해당 게시판의 글 목록을 반환합니다.

GET /boards/1/posts

응답은 JSON 형태로 반환될 수 있습니다.

{
  "posts": [
    {
      "id": 1,
      "title": "첫 번째 글",
      "content": "첫 번째 글의 내용입니다.",
      "author": "John Doe",
      "created_at": "2023-02-25T09:00:00Z",
      "updated_at": "2023-02-25T09:00:00Z"
    },
    {
      "id": 2,
      "title": "두 번째 글",
      "content": "두 번째 글의 내용입니다.",
      "author": "Jane Smith",
      "created_at": "2023-02-26T14:30:00Z",
      "updated_at": "2023-02-26T14:30:00Z"
    }
  ]
}

즉 GET /boards/1/posts URL 호출하면 준비되어있는 json 안에 posts의 id:1 정보들을 반환해주는 것

profile
Challenger

0개의 댓글