โœ๏ธ

์‚ฌ์šฉ์ž๋Š” ๋Œ€๊ฒฐ ์ƒ๋Œ€๋ฅผ ์ฐพ๊ธฐ ์œ„ํ•ด ๋Œ€๊ฒฐ ๊ณต๊ณ ๋ฅผ ์ž‘์„ฑํ•œ๋‹ค.

Related to ๋ฆฌํŒฉํ„ฐ๋ง ๋ชฉ๋ก (๐Ÿงจ API & Sequence diagram) 1
Method
POST
BE.๋‹ด๋‹น์ž
End Point
/api/matches
Group
Matches
MoSCow
Must have
์ง„ํ–‰์ƒํƒœ
์™„๋ฃŒ
Related to ๋ฆฌํŒฉํ„ฐ๋ง ๋ชฉ๋ก (๐Ÿงจ API & Sequence diagram) 2
Related to ๋ฆฌํŒฉํ„ฐ๋ง ๋ชฉ๋ก (๐Ÿงจ API & Sequence diagram)

์ตœ์ข…๋ณธ

๐Ÿญ
์ตœ์ข… ํ™•์ • ์ผ์ž : 2022-00-00 (?)
  • ๋ณ€๊ฒฝ ์‚ฌํ•ญ
    • ๋ณ€๊ฒฝ ์‚ฌํ•ญ์ด ์žˆ๋‹ค๋ฉด ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.
sequenceDiagram ์•กํ„ฐ ->> Client: ๋Œ€๊ฒฐ ๊ณต๊ณ  ์ž‘์„ฑ ์š”์ฒญ Client->>API_Server: POST /api/matches Note over Client, API_Server: ๋Œ€๊ฒฐ ๊ณต๊ณ  ์ž‘์„ฑํ•˜๋Š” API ์š”์ฒญ API_Server ->> Match : ๋Œ€๊ฒฐ ๊ณต๊ณ  ์ž‘์„ฑ ์š”์ฒญ Match -->> API_Server : ๋งค์น˜ ์‘๋‹ต ๋ฐ ์˜ˆ์™ธ์ฒ˜๋ฆฌ API_Server -->> Client : ๋งค์น˜ ์‘๋‹ต ๋ฐ ์—์™ธ์ฒ˜๋ฆฌ Client -->> ์•กํ„ฐ : UI ์—…๋ฐ์ดํŠธ

Request

{ "title": String, "matchDate": String, "matchType": String, "teamId" : Number, "participants": Number, // ์ถœ์ „ ์ธ์› ์ˆ˜ "sportsCategory": String, "content": String, }

Response

notion image
  • ๊ธ€์“ฐ๊ธฐ ๋ฒ„ํŠผ์„ ๋ˆ„๋ฅธ๋‹ค.
  • ์ข…๋ชฉ ์„ ํƒ์„ ํ•œ๋‹ค.
    • ๋ชจ๋“  ์ข…๋ชฉ ๋‹ค ๋ฝ‘๋Š”๋‹ค.
  • ๊ฐœ์ธ์ „์„ ์„ ํƒํ•œ๋‹ค.
    • ๊ฐœ์ธ์ „ ์„ ํƒ์˜ ๊ฒฝ์šฐ ์ธ์›์„ 1๋กœ default ์‹œํ‚จ๋‹ค ?
  • ํŒ€์ „์„ ์„ ํƒํ•œ๋‹ค.
    • ํ•ด๋‹น ์ข…๋ชฉ์„ ๊ฐ€์ง€๊ณ  ๋‚ด๊ฐ€ ๋ฆฌ๋”์ธ ํŒ€๋“ค๋งŒ ์กฐํšŒ ๊ฐ€๋Šฅํ•˜๊ฒŒ ํ•œ๋‹ค.
    • ํŒ€ ์„ ํƒ์„ ํ•˜์ง€ ์•Š์œผ๋ฉด ๊ธ€ ๋“ฑ๋ก ๋ชปํ•˜๊ฒŒ ํ•œ๋‹ค.
 
ํ™€๋ฆฌ ๋ชฐ๋ฆฌ
  • ๊ธ€์“ฐ๊ธฐ ๋ฒ„ํŠผ์„ ํด๋ฆญํ•œ๋‹ค.
    • โ†’ ์‚ฌ์šฉ์ž์— ๋Œ€ํ•œ ์ •๋ณด API ์š”์ฒญ(๋ณธ์ธ์ด ๋ฆฌ๋”์ธ ํŒ€ ์ •๋ณด)
  • ํ”„๋ก ํŠธ์—์„œ๋Š” ํ•ด๋‹น ์ •๋ณด๋“ค์„ ๊ฐ€์ง€๊ณ  ์œ ํšจ์„ฑ ๊ฒ€์‚ฌ๋ฅผ ํ•œ๋‹ค.
    • ๊ฐœ์ธ์ „์ผ ๊ฒฝ์šฐ
      • ์ข…๋ชฉ : All
      • ์ธ์› ์„ ํƒ : 1๋ช… ๊ณ ์ •
      • ํŒ€ ์„ ํƒ : ๋น„ํ™œ์„ฑํ™”
    • ํŒ€์ „์ธ ๊ฒฝ์šฐ
      • ์ข…๋ชฉ : ๋ณธ์ธ์ด ๋ฆฌ๋”์ธ ํŒ€์˜ ์Šคํฌ์ธ  ๋ชฉ๋ก๋งŒ ์„ธํŒ…
      • ํŒ€ ์„ ํƒ : ์Šคํฌ์ธ  ์ข…๋ชฉ์„ ์„ ํƒํ•˜๋ฉด ํ•ด๋‹น ์Šคํฌ์ธ  ์ข…๋ชฉ์˜ ๋ณธ์ธ์ด ํŒ€ ๋ฆฌ๋”์ธ ํŒ€ ๋ชฉ๋ก ์กฐํšŒ
  • ๊ธ€์“ฐ๊ธฐ ๋ฒ„ํŠผ์„ ํด๋ฆญํ•œ๋‹ค.
    • ๋ฐฑ์—”๋“œ์—์„œ๋Š” ํŒ€์ „์ด๋ผ๋ฉด ํ•ด๋‹น ํšŒ์›์ด ๊ทธ ํŒ€์˜ ๋ฆฌ๋”์ธ์ง€ ํ™•์ธ ํ›„์— ์ €์žฅํ•œ๋‹ค.
 
NULL
ํŒ€์ „์ผ๋•Œ,
  • ์ข…๋ชฉ์„ ๋จผ์ € ์„ ํƒํ•˜๊ฒŒ ํ•œ๋‹ค. (์ข…๋ชฉ์„ ์„ ํƒํ•˜์ง€ ์•Š์œผ๋ฉด ํŒ€์„ ํƒ ๋ถˆ๊ฐ€๋Šฅ)
  • ๋‚ด๊ฐ€ ํŒ€ ๋ฆฌ๋”์ธ ํŒ€ ์ค‘์— ์„ ํƒํ•œ ์ข…๋ชฉ์— ํ•ด๋‹นํ•˜๋Š” ํŒ€์„ ๋ถˆ๋Ÿฌ์˜จ๋‹ค. (API ํ˜ธ์ถœ์ด๋“ , JS๋กœ๋“ )
  • ์ข…๋ชฉ, ํŒ€ ์„ ํƒ์ด ์™„๋ฃŒ๋˜์—ˆ๋‹ค๋ฉด ๊ธ€์“ฐ๊ธฐ๋ฅผ ๋ˆ„๋ฅผ ์ˆ˜ ์žˆ๋‹ค.
 
  • ๋ฐฑ์—”๋“œ์—์„œ๋Š” ๋”๋ธ” ์ฒดํ‚น
    • ํŒ€์ „์ธ์ง€
    • ์ข…๋ชฉ์ด ์„ ํƒ๋˜์—ˆ๋Š”์ง€
    • ์„ ํƒํ•œ ์ข…๋ชฉ์— ํ•ด๋‹นํ•˜๋Š” ํŒ€์ธ์ง€
    • ๋‚ด๊ฐ€ ํŒ€ ๋ฆฌ๋”์ธ์ง€