SIAT WIKI Backend 💛

SIAT WIKI

SIAT A반 사람들에 대해 알아보는 WIKI 프로젝드 입니다.

Table of Contents

1. About The Project
   • Languages, libraries and tools used
2. Getting Started
3. Feature
4. Roadmap
5. Contributing
6. Contact
7. Coming Soon

About The Project

이 프로젝트는 SIAT A반 사람들이 각자의 위키를 만들어 자신의 Tech Stack이나 하고 싶은 Project 설명을 직접 작성할 수 있는 WIKI Backend Project 입니다.

(back to top)

Languages, libraries and tools used

Languages

• JAVA
  • version: JDK-17

framework

• Spring Boot
  • version: 3.3.0
  • project: Maven

libraries

• SpringBoot data-jpa
  • version: 3.3.0
• SpringBoot starter-web
  • version: 3.3.0
• SpringBoot devtools
  • vsrsion: 3.3.0
• mysql-connector-j
  • version: 8.3.0
• lombok
  • version: 1.18.32
• SpringBoot starter-test
  • version: 3.3.0
• querydsl-apt
  • version: 5.1.0
• querydsl-jpa
  • version: 5.1.0

(back to top)

Getting Started

1. Clone the repo

   git clone https://github.com/SIAT-Python-Project/SIATwiki-backend.git

2. Build Project

cd ./SIATwiki-backend
mvn -B package -DskipTests=true --file pom.xml

4. Run

java -jar ./target/siatwiki-0.0.1-SNAPSHOT.jar

(back to top)

Feature

1. Create User

• use cookie auth

2. Create and Read Person
   • profile img upload
3. Write Person Info
   • Add Github Markdown style

(back to top)

Roadmap

• User CRUD
• Person CRUD
• Info CRUD
• Add Person profile image
• Add Global Exception Handler
• Cookie auth

See the project issues for a full list of proposed features(and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

API 명세서

Category API 명세서

Domain	메소드 방식	요청 경로	요청값	반환값
Category	GET	/api/info/category		CategoryResponseDto

Info API 명세서

Domain	메소드 방식	요청 경로	요청값	반환값
Info	POST	/api/info	InfoDto.InfoRequestDto	InfoDto.InfoResponseDto
Info	GET	/api/info/{infoId}		InfoDto.InfoResponseDto
Info	GET	/api/info/person/{personId}		List<InfoDto.InfoResponseDto>
Info	PUT	/api/info/{infoId}	InfoDto.InfoRequestDto	InfoDto.InfoResponseDto

Person API 명세서

Domain	메소드 방식	요청 경로	요청값	반환값
Person	GET	/api/person/{personId}		PersonDTO.PersonResponseDTO
Person	POST	/api/person	PersonDTO.PersonRequestDTO, MultipartFile	PersonDTO.PersonResponseDTO
Person	PUT	/api/person/{personId}	PersonDTO.PersonRequestDTO, MultipartFile	PersonDTO.PersonResponseDTO
Person	DELETE	/api/person/{personId}		void
Person	GET	/api/person		List<PersonDTO.PersonIdNameDTO>

User API 명세서

Domain	메소드 방식	요청 경로	요청값	반환값
User	POST	/api/sign-up	UserDTO.UserRequestDTO	User
User	POST	/api/login	UserDTO.UserRequestDTO	Boolean
User	POST	/api/logout		Boolean
User	POST	/api/userFind	UserDTO.UserRequestDTO	List<UserDTO.UserResponseDTO>

Coming Soon

• Continuous Delivery
• Server Distribution

(back to top)

Contact

hg_yellow

• GitHub: hg_yellow
• Mail: [email protected]

배창민

• GitHub: Changchang
• Mail: [email protected]

김지혜

• GitHub: wisdom
• Mail: [email protected]

Project Link: SIATwiki-backend
Project Link: SIATwiki-frontend
Project Team Link: SIAT-Project

(back to top)