Skip to content

πŸ“„[λ¬Έμ„œ][λ¬Έμ„œ] API μŠ€νŽ™ λ¬Έμ„œ docs 폴더 μΆ”κ°€Β #20

Description

@Cassiiopeia

πŸ“ ν˜„μž¬ 문제점

  • API 섀계 μŠ€νŽ™ λ¬Έμ„œκ°€ λ‘œμ»¬μ—λ§Œ μ‘΄μž¬ν•˜λ©° ν”„λ‘œμ νŠΈ μ €μž₯μ†Œμ— ν¬ν•¨λ˜μ–΄ μžˆμ§€ μ•ŠμŒ
  • 곡톡 κ·œμΉ™, 인증, 할일, 타이머, μ—°λ£Œ, νƒν—˜, λ°°μ§€, μ†Œμ…œ λ“± μ „ 도메인에 걸친 API μŠ€νŽ™μ΄ λ¬Έμ„œν™”λ˜μ–΄ μžˆμœΌλ‚˜ νŒ€μ›μ΄ μ ‘κ·Όν•  수 μ—†λŠ” μƒνƒœ

πŸ› οΈ ν•΄κ²° λ°©μ•ˆ / μ œμ•ˆ κΈ°λŠ₯

  • docs/api-specs/ κ²½λ‘œμ— 도메인별 API μŠ€νŽ™ λ§ˆν¬λ‹€μš΄ 파일 8개 μΆ”κ°€
  • 곡톡 κ·œμΉ™(인증 방식, 응닡 ν˜•μ‹, νŽ˜μ΄μ§€λ„€μ΄μ…˜ λ“±) 및 전체 μ—”λ“œν¬μΈνŠΈ λͺ©λ‘ 포함

βš™οΈ μž‘μ—… λ‚΄μš©

  • docs/api-specs/00_common.md : 곡톡 κ·œμΉ™, 전체 32개 μ—”λ“œν¬μΈνŠΈ λͺ©λ‘
  • docs/api-specs/01_auth.md : 인증 + ν”„λ‘œν•„ 6개 μ—”λ“œν¬μΈνŠΈ
  • docs/api-specs/02_todo.md : 할일 + μΉ΄ν…Œκ³ λ¦¬ 8개 μ—”λ“œν¬μΈνŠΈ
  • docs/api-specs/03_timer.md : 타이머 μ„Έμ…˜ 3개 μ—”λ“œν¬μΈνŠΈ
  • docs/api-specs/04_fuel.md : μ—°λ£Œ μ‹œμŠ€ν…œ 2개 μ—”λ“œν¬μΈνŠΈ
  • docs/api-specs/05_exploration.md : νƒν—˜ 4개 μ—”λ“œν¬μΈνŠΈ
  • docs/api-specs/06_badge.md : λ°°μ§€ 2개 μ—”λ“œν¬μΈνŠΈ
  • docs/api-specs/07_social.md : 친ꡬ + λž­ν‚Ή 7개 μ—”λ“œν¬μΈνŠΈ

πŸ™‹β€β™‚οΈ λ‹΄λ‹Ήμž

  • λ°±μ—”λ“œ: 이름
  • ν”„λ‘ νŠΈμ—”λ“œ: 이름
  • λ””μžμΈ: 이름

Metadata

Metadata

Assignees

Labels

μž‘μ—…μ™„λ£Œμž‘μ—… μ™„λ£Œ μƒνƒœμΈ 경우 (이슈 폐쇄)

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions