User Management API

현대적인 디자인 시스템으로 재탄생한 사용자 관리 API 명세서입니다. 모든 컴포넌트는 재사용 가능하며, 가독성과 사용성에 초점을 맞춰 설계되었습니다.

프로젝트명User Management API

API 버전v2.0.0

OpenAPI 버전3.0.3

Base URLhttps://api.example.com/v2

문서 버전2.0.0

최종 수정일2025-06-29

기술 스택

Backend

languageJava 17

frameworkSpring Boot 3.2.0

databaseMySQL 8.0

ORMSpring Data JPA

cacheRedis 7.0

searchElasticsearch 8.11

DevOps & Monitoring

containerDocker + Kubernetes

CI/CDGitHub Actions

monitoringPrometheus + Grafana

loggingELK Stack

gatewaySpring Cloud Gateway

사용자 관리 API

GET

/users

사용자 목록 조회

v2.0

페이지네이션을 지원하는 사용자 목록을 조회합니다.

상세 정보 보기

Query Parameters

Parameter	Type	Required	Description
page	integer	No	페이지 번호 (0부터 시작) Default: 0
size	integer	No	페이지 당 항목 수 (최대 100) Default: 20
sort	string	No	정렬 기준 (ex: 'id,asc') Default: id,asc

Responses

200성공 응답

{
  "content": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  ],
  "pagination": {
    "page": 0,
    "size": 20,
    "totalElements": 123,
    "totalPages": 7
  }
}

400잘못된 파라미터 요청 응답

{
  "error": "Invalid parameter: size must be between 1 and 100"
}

Code Examples

cURLcurl

curl -X GET "https://api.example.com/v2/users?page=0&size=10" \
-H "Authorization: Bearer YOUR_API_TOKEN"

GET

/users/{userId}

단일 사용자 조회

Deprecatedv2.0

ID를 사용하여 특정 사용자의 정보를 조회합니다.

상세 정보 보기

Path Parameters

Parameter	Type	Required	Description
userId	long	Yes	조회할 사용자의 고유 ID

Responses

200성공적으로 사용자를 조회했을 때의 응답입니다.

{
  "id": 123,
  "name": "Jane Doe",
  "email": "jane.doe@example.com",
  "status": "ACTIVE"
}

404해당 ID의 사용자를 찾을 수 없을 때의 응답입니다.

{
  "error": "User not found with id: 123"
}