Git Product home page Git Product logo

dividend's Introduction

๐Ÿฆ ์‹ค์ „ ๋ฐฐ๋‹น๊ธˆ ํ”„๋กœ์ ํŠธ

ํฌ๋กค๋ง์„ ํ†ตํ•ด ์ฃผ์‹ ๋ฐ์ดํ„ฐ๋ฅผ ๊ฐ€์ ธ์™€ ๋ฐฐ๋‹น๊ธˆ์„ ์•Œ์•„๋ณด๋Š” ํ”„๋กœ์ ํŠธ์ž…๋‹ˆ๋‹ค.

Front-end

๐Ÿ› ๏ธ Development Environment

  • ๐Ÿ–ฅ๏ธ Intellij IDEA Ultimate
  • โ˜• Java 17
  • โ˜• Jdk 17
  • ๐Ÿ”ง Gradle 8.8
  • ๐ŸŒฑ Spring Boot 3.3.2

๐Ÿงฐ Tech Stack

  • Frameworks & Libraries: Spring Boot, Spring Security, Spring Data JPA
  • Databases: H2, Redis
  • Web Scraping: Jsoup
  • Authentication: JWT
  • Utilities: Lombok, Sl4J, Logback, Swagger

๐Ÿ“– API Documentation

Swagger
swagger

๐Ÿ” /auth

ํšŒ์›๊ฐ€์ž… API
  • POST /signup
    • ์ค‘๋ณต ID๋Š” ํ—ˆ์šฉํ•˜์ง€ ์•Š์Œ
    • ํŒจ์Šค์›Œ๋“œ๋Š” ์•”ํ˜ธํ™”๋œ ํ˜•ํƒœ๋กœ ์ €์žฅ๋จ
๋กœ๊ทธ์ธ API
  • POST /signin
    • ๋กœ๊ทธ์ธ API
    • ํšŒ์›๊ฐ€์ž…์ด ๋˜์–ด์žˆ๊ณ , ์•„์ด๋””/ํŒจ์Šค์›Œ๋“œ๊ฐ€ ์ผ์น˜ํ•˜๋Š” ๊ฒฝ์šฐ JWT ๋ฐœ๊ธ‰

๐Ÿข /company

ํšŒ์‚ฌ๋ช… ๊ฒ€์ƒ‰ API
  • GET /autocomplete
    • ๊ฒ€์ƒ‰ํ•˜๊ณ ์ž ํ•˜๋Š” prefix๋ฅผ ์ž…๋ ฅ๊ฐ’์œผ๋กœ ๋ฐ›๊ณ , ํ•ด๋‹น prefix๋กœ ๊ฒ€์ƒ‰๋˜๋Š” ํšŒ์‚ฌ๋ช… ๋ฆฌ์ŠคํŠธ ์ค‘ 10๊ฐœ ๋ฐ˜ํ™˜
    • keyword ํŒŒ๋ผ๋ฏธํ„ฐ๋กœ ๋ฐฐ๋‹น๊ธˆ ์ด๋ฆ„์„ ๊ฒ€์ƒ‰ํ•˜๋ฉด {result:["O","OAS",...]} ์™€ ๊ฐ™์ด ํ•ด๋‹น ๊ธ€์ด ๋“ค์–ด๊ฐ„ ๋ฐฐ๋‹น๊ธˆ ํ‚ค์›Œ๋“œ๋ฅผ ๋ฐ˜ํ™˜
ํšŒ์‚ฌ ๋ชฉ๋ก ํ™•์ธ API
  • GET
    • ์„œ๋น„์Šค์—์„œ ๊ด€๋ฆฌํ•˜๊ณ  ์žˆ๋Š” ๋ชจ๋“  ํšŒ์‚ฌ ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜
    • ๋ฐ˜ํ™˜ ๊ฒฐ๊ณผ๋Š” Page ์ธํ„ฐํŽ˜์ด์Šค ํ˜•ํƒœ
    • {result : [{companyName: "์ข‹์€ํšŒ์‚ฌ", ticker : "GOOD"}, {companyName:"a", ticker:"b"}, ...]}
ํšŒ์‚ฌ ์ •๋ณด ์ถ”๊ฐ€ API
  • POST
    • ์ถ”๊ฐ€ํ•˜๊ณ ์ž ํ•˜๋Š” ํšŒ์‚ฌ์˜ ticker๋ฅผ ์ž…๋ ฅ๋ฐ›์•„ ํ•ด๋‹น ํšŒ์‚ฌ ์ •๋ณด๋ฅผ ์Šคํฌ๋ž˜ํ•‘, ์ €์žฅ
    • ์ด๋ฏธ ๋ณด์œ ํ•˜๊ณ  ์žˆ๋Š” ํšŒ์‚ฌ์˜ ๊ฒฝ์šฐ 400 status ์ฝ”๋“œ์™€ ์—๋Ÿฌ๋ฉ”์„ธ์ง€ ๋ฐ˜ํ™˜
    • ์กด์žฌํ•˜์ง€ ์•Š๋Š” ํšŒ์‚ฌ ticker์ผ ๊ฒฝ์šฐ 400 status ์ฝ”๋“œ์™€ ์—๋Ÿฌ๋ฉ”์„ธ์ง€ ๋ฐ˜ํ™˜
    • {ticker : "GOOD"} ticker ํŒŒ๋ผ๋ฏธํ„ฐ๋กœ ๋ฐ›์•„์ฃผ์„ธ์š”
    • DB์— {ticker : "GOOD", companyName : "์ข‹์€ํšŒ์‚ฌ"} ์ด๋ ‡๊ฒŒ ์ €์žฅํ•ฉ๋‹ˆ๋‹ค
ํšŒ์‚ฌ ์ •๋ณด ์‚ญ์ œ API
  • DELETE /{ticker}
    • ticker์— ํ•ด๋‹นํ•˜๋Š” ํšŒ์‚ฌ ์ •๋ณด ์‚ญ์ œ
    • ์‚ญ์ œ ์‹œ ํšŒ์‚ฌ์˜ ๋ฐฐ๋‹น๊ธˆ ์ •๋ณด์™€ ์บ์‹œ๋„ ๋ชจ๋‘ ์‚ญ์ œ

๐Ÿ’ฐ /finance

๋ฐฐ๋‹น๊ธˆ ์ •๋ณด ํ™•์ธ API
  • GET /dividend/{companyName}
    • ํšŒ์‚ฌ๋ช…์„ ๋ฐ›์•„ ํšŒ์‚ฌ ๋ฉ”ํƒ€ ์ •๋ณด์™€ ๋ฐฐ๋‹น๊ธˆ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜
    • ์ž˜๋ชป๋œ ํšŒ์‚ฌ๋ช…์ด ์ž…๋ ฅ์œผ๋กœ ๋“ค์–ด์˜จ ๊ฒฝ์šฐ 400 status ์ฝ”๋“œ์™€ ์—๋Ÿฌ๋ฉ”์„ธ์ง€ ๋ฐ˜ํ™˜
    • {companyName : "์ข‹์€ํšŒ์‚ฌ", dividend :[{date:"2023.10.29", price:"2.00", ...}]}

๐Ÿ“ฎPostMan API ํ…Œ์ŠคํŠธ

ํšŒ์›๊ฐ€์ž… ๋กœ๊ทธ์ธ
ํšŒ์›๊ฐ€์ž… ๋กœ๊ทธ์ธ
ํšŒ์‚ฌ ์กฐํšŒ ํšŒ์‚ฌ ์ €์žฅ
ํšŒ์‚ฌ์กฐํšŒ ํšŒ์‚ฌ์ถ”๊ฐ€
ํšŒ์‚ฌ ์ž๋™์™„์„ฑ ๋ฐฐ๋‹น๊ธˆ ์กฐํšŒ
์ž๋™์™„์„ฑ ๋ฐฐ๋‹น๊ธˆ์กฐํšŒ

๐Ÿ›‘Redis

Redis ํšŒ์‚ฌ ์บ์‹œ ์ €์žฅ Redis ํšŒ์‚ฌ ์บ์‹œ ์‚ญ์ œ
redis์บ์‹œ Redis์บ์‹œ์‚ญ์ œ

๐Ÿ–ฅ๏ธH2 Console

ํšŒ์› ์ •๋ณด ํšŒ์› ์—ญํ• 
๋ฉค๋ฒ„์ •๋ณด ๋ฉค๋ฒ„์—ญํ• 
ํšŒ์‚ฌ ์กฐํšŒ ๋ฐฐ๋‹น๊ธˆ ์กฐํšŒ
ํšŒ์‚ฌ์ •๋ณด ๋ฐฐ๋‹น๊ธˆ

dividend's People

Contributors

seokseungmin avatar

Watchers

 avatar

dividend's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.