Skip to content

Commit

Permalink
Merge pull request #53 from 2024-TEAM-05/docs/api-explanation
Browse files Browse the repository at this point in the history
docs: API 명세서 리드미에 추가
  • Loading branch information
jooda00 authored Aug 26, 2024
2 parents aeec06d + 0731532 commit 0e2d8f7
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,19 @@
- [✨ 개요](#-개요)
- [🧩 Skills](#-skills)
- [Installation](#Installation)
- [💌 API 명세서](#-api-명세서)
- [📄 요구사항 정리 및 기술 명세서](#-요구사항-정리-및-기술-명세서)
- [🏗️ ERD](#%EF%B8%8F-erd)
- [🕝 프로젝트 진행 및 이슈 관리](#-프로젝트-진행-및-이슈-관리)
- [👾 Authors](#-authors)


</br>

## ✨ 개요

다양한 소셜 미디어 플랫폼을 통해 수많은 정보를 접할 수 있게 되었지만, 여러 SNS 상에서 산발적으로 게시되는 컨텐츠를 일일이 확인하고 관리하는 건 굉장히 번거로운 일입니다. 어떤 주제나 브랜드에 대해 다양한 사용자 입장에서 모니터링하려면 각 플랫폼을 따로 관리해야 하는 불편함이 있습니다. 이런 문제를 해결할 수 있는 소셜 미디어 통합 Feed 애플리케이션입니다.

`소셜 미디어 통합 Feed 서비스``유저 계정` 또는 브랜드의 `#해시태그`를 기반으로 인스타그램, 쓰레드, 페이스북, 트위터(X) 등 다양한 SNS에 게시된 관련 컨텐츠를 하나의 피드로 통합하여 제공합니다. 이를 통해 관심 있는 주제나 브랜드의 SNS 노출 현황과 통계를 한눈에 쉽게 확인할 수 있습니다.

<br/>

</br>

## 🧩 Skills

언어 및 프레임워크: `Java 17`, `Spring Boot 3.x.x`
Expand All @@ -38,8 +33,9 @@ ETC: `QueryDsl`, `Swagger`, `Lombok`, `Junit`

협업툴: `GitHub`, `Discord`, `Notion`

<br/>

## 💌 API 명세서
#### 스웨거 주소
http://15.164.10.5:9020/swagger-ui/index.html#/
## 📄 요구사항 정리 및 기술 명세서

<details>
Expand Down

0 comments on commit 0e2d8f7

Please sign in to comment.