모든 사용자 정보를 가져옴: GET /users

hi·2023년 6월 18일
0

API 설계

목록 보기
3/14

API 이름

Get All Users API

API 개요

이 API는 모든 사용자 정보를 가져오는 데 사용됩니다.

엔드포인트

GET /users

요청

요청 헤더

없음

요청 바디

없음

매개변수

없음

응답

응답 헤더

Content-Type: application/json

응답 바디

{
  "users": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "johndoe@example.com"
    },
    {
      "id": 2,
      "name": "Jane Smith",
      "email": "janesmith@example.com"
    }
  ]
}

상태 코드

  • 200: 성공적으로 사용자 목록을 가져옴
  • 500: 서버 오류

예시

요청 예시

GET /users

응답 예시

HTTP/1.1 200 OK
Content-Type: application/json

{
  "users": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "johndoe@example.com"
    },
    {
      "id": 2,
      "name": "Jane Smith",
      "email": "janesmith@example.com"
    }
  ]
}

오류 처리

  • 500: 서버 오류. 사용자 목록을 가져오는 동안 내부 서버 오류가 발생함

보안

이 API는 SSL/TLS를 통해 암호화된 연결을 사용합니다.

인증

이 API는 인증이 필요하지 않습니다.

Rate Limiting

이 API는 1분당 최대 1000개의 요청을 허용합니다.

버전 관리

현재 버전: v1

변경 이력

  • v1 (2023-06-01): 초기 버전

0개의 댓글