JIB

유학생을 위한 위치기반 장기 숙박 공유 플랫폼, JIB의 API 서버 저장소입니다.

Tech

BackEnd

- Java 11
- SpringBoot 2.3.3.RELEASE
- Lombok
- JWT
- JPA
- Swagger
- JUnit 5

FrontEnd

- React

DB

- Postgresql
- MongoDB

Infra

Project Structure

└─ src
    ├─ main
    │   ├─ java       
    │   │   └─ com   
    │   │        └─ j2kb  
    │   │             └─ jibapi     
    │   │                  ├─ domain
    │   │                  │   ├─ member   
    │   │                  │   │   ├─ api       - RestController 
    │   │                  │   │   ├─ dao       - Repository
    │   │                  │   │   ├─ dto       - Request, Response obj
    │   │                  │   │   ├─ entity    - domain entity, Enum
    │   │                  │   │   ├─ enums     - Enum
    │   │                  │   │   └─ service   - bisiness logic
    │   │                  │   ├─ ...   
    │   │                  │   │   ├─ api       - RestController 
    │   │                  │   │   ├─ dao       - Repository
    │   │                  │   │   ├─ dto       - Request, Response obj
    │   │                  │   │   ├─ entity    - domain entity
    │   │                  │   │   ├─ enums     - Enum 
    │   │                  │   │   └─ service   - bisiness logic    
    │   │                  └─ global
    │   │                       ├─ common         - 공통사용 obj
    │   │                       ├─ config         - 설정
    │   │                       │   ├─ external  - 외부 lib ( azure client / aws client )
    │   │                       │   ├─ security  - springSecurity config   
    │   │                       │   └─ other        
    │   │                       ├─ error     
    │   │                       │   ├─ exception - exception
    │   │                       │   └─ other
    │   │                       └─ util           - util
    │   └─ resources
    │        ├─ application.properties
    │        ├─ application-local.properties
    │        ├─ application-dev.properties                    
    │        └─ application-prod.properties

진행방향

• 테스트코드 작성
• 클린코드 지향
• AngularJS Commit Message Conventions 참고 commit log
• CI/CD : Jenkins?

Swagger URL

• http://localhost:8080/swagger-ui/index.html

Return Obj

SucessResponse

{
  "status": 200,
  "message": "OK",
  "payload": {
    "memberNo": 1,
    "phoneNumber": "01022572652",
    "memberName": "황명권",
    "memberId": "[email protected]"
  }
}

ErrorResponse

{
  "message": " Invalid Input Value",
  "status": 400,
  "errors": [
    {
      "field": "memberName",
      "value": "",
      "reason": "널이어서는 안됩니다"
    }
  ],
  "code": "C001"
}