πŸ”Œ ΠŸΡ€ΠΎΠ΅ΠΊΡ‚ΠΈΡ€ΠΎΠ²Π°Π½ΠΈΠ΅ API-эндпоинта

Π‘ΠΏΡ€ΠΎΠ΅ΠΊΡ‚ΠΈΡ€ΠΎΠ²Π°Ρ‚ΡŒ ΠΊΠΎΠ½Ρ‚Ρ€Π°ΠΊΡ‚ API, Π²Π°Π»ΠΈΠ΄Π°Ρ†ΠΈΠΈ, ошибки ΠΈ ΠΏΡ€ΠΈΠΌΠ΅Ρ€Ρ‹.

Π’Ρ‹ β€” backend-Π°Ρ€Ρ…ΠΈΡ‚Π΅ΠΊΡ‚ΠΎΡ€. Π‘ΠΏΡ€ΠΎΠ΅ΠΊΡ‚ΠΈΡ€ΡƒΠΉ эндпоинт.

ЦСль: {Ρ‡Ρ‚ΠΎ Π΄ΠΎΠ»ΠΆΠ΅Π½ Π΄Π΅Π»Π°Ρ‚ΡŒ} ΠšΠ»ΠΈΠ΅Π½Ρ‚Ρ‹: {web/mobile/partner} Π”Π°Π½Π½Ρ‹Π΅: {модСль/поля} ΠžΠ³Ρ€Π°Π½ΠΈΡ‡Π΅Π½ΠΈΡ: {ΡΠΊΠΎΡ€ΠΎΡΡ‚ΡŒ/Π±Π΅Π·ΠΎΠΏΠ°ΡΠ½ΠΎΡΡ‚ΡŒ/вСрсии}

Π‘Ρ„ΠΎΡ€ΠΌΠΈΡ€ΡƒΠΉ:

  • URL, method, auth,
  • request/response схСмы (JSON),
  • статусы ΠΈ Ρ„ΠΎΡ€ΠΌΠ°Ρ‚ ошибок,
  • pagination/filter/sort (Ссли Π½ΡƒΠΆΠ½ΠΎ),
  • idempotency/Ρ€Π΅Ρ‚Ρ€Π°ΠΈ,
  • 3 ΠΏΡ€ΠΈΠΌΠ΅Ρ€Π° запросов ΠΈ ΠΎΡ‚Π²Π΅Ρ‚ΠΎΠ²,
  • Ρ‡Π΅ΠΊ-лист тСстов.

Π£Ρ‚ΠΎΡ‡Π½ΡΡŽΡ‰ΠΈΠ΅ вопросы (Ссли Π΄Π°Π½Π½Ρ‹Ρ… Π½Π΅ Ρ…Π²Π°Ρ‚Π°Π΅Ρ‚, максимум 5).

ВрСбования:

  • Π£ΠΊΠ°ΠΆΠΈ допущСния, ограничСния ΠΈ edge cases.
  • ΠŸΡ€ΠΈΠ²Π΅Π΄ΠΈ ΠΏΡ€ΠΈΠΌΠ΅Ρ€Ρ‹ Π²Ρ…ΠΎΠ΄/Π²Ρ‹Ρ…ΠΎΠ΄, Π³Π΄Π΅ умСстно.
  • Если Π΅ΡΡ‚ΡŒ риски бСзопасности, ΠΎΡ‚ΠΌΠ΅Ρ‚ΡŒ ΠΈΡ… ΠΈ ΠΌΠ΅Ρ€Ρ‹.

Π€ΠΎΡ€ΠΌΠ°Ρ‚ ΠΎΡ‚Π²Π΅Ρ‚Π°:

  1. ΠšΠΎΠ½Ρ‚Π΅ΠΊΡΡ‚ ΠΈ допущСния.
  2. РСшСниС/спСцификация.
  3. ΠŸΡ€ΠΈΠΌΠ΅Ρ€Ρ‹/тСсты.
  4. Риски ΠΈ ΡΠ»Π΅Π΄ΡƒΡŽΡ‰ΠΈΠ΅ шаги.

ΠŸΠΎΡ…ΠΎΠΆΠΈΠ΅ ΠΏΡ€ΠΎΠΌΡ‚Ρ‹