[프로젝트] README 적용

1. README 구성

이제 프로젝트 README를 작성해보려고 한다.

README 구성은 아래와 같이 작성하려고 한다.

---------------------------------------------------------------

앱 이름
---------------------------------------------------------------

앱 설명

---------------------------------------------------------------

버전 정보 작성(JDK, Spring Boot 등)

---------------------------------------------------------------

사용된 third party + 사용된 기술들

(redis, spring jpa, spring security, oauth..)

---------------------------------------------------------------

API 정의서 + 상태코드

---------------------------------------------------------------

ERD
---------------------------------------------------------------

2. API 정의서

## **API 정의서와 상태 코드**
### **📌 User API 문서**

#### **[POST] 회원가입**
- **Endpoint:** `/user/sign-up`
- **Request Body:**
  ```json
  {
    "userId": 123,
    "name": "홍길동",
    "email": "test@example.com",
    "nickname": "testuser",
    "birth": "1995-07-30",
    "provider": "google",
    "providerUid": "google-12345",
    "accessToken": "access-token-example",
    "refreshToken": "refresh-token-example"
  }
  ```
- **Response:**
  ```json
  {
    "userId": 123,
    "name": "홍길동",
    "email": "test@example.com",
    "nickname": "testuser",
    "birth": "1995-07-30",
    "provider": "google",
    "providerUid": "google-12345",
    "accessToken": "access-token-example",
    "refreshToken": "refresh-token-example",
    "isRegistered": true,
    "createdAt": "2025-01-28 12:00:00",
    "updatedAt": "2025-01-28 12:00:00",
    "createdBy": 101,
    "updatedBy": 101
  }
  ```
- **Status Codes:**
  - `201 Created` : 회원가입 성공
  - `400 Bad Request` : 요청 데이터 오류

 

위와 같이 API 정의서는 HTTP Method, 기능 이름, Endpoint, Request Body, Response Body(Json), status code로 정리하였다.

아직은 기능 정리가 더 필요하여서 예시로 User, Card만 추가하였다.

3. 버전 정보 작성

./gradlew dependencies 를 통해서 프로젝트의 버전 정보를 쉽게 확인할 수 있다.

./gradlew dependencies