edamov / xapi

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Введение

Требования и стандарты к разработки и документированию API.

План:

  • Процесс разработки (какие этапы и последовательность)
  • RPC vs REST
  • Public API and private API
  • Документирование. Тулзы для документирования, их сравнение.
  • HATEOAS. Нужен ли и какие варианты.
  • Базовые понятия. Methods. Endpoints.
  • Resources (CRUD)
  • Формат ответа. Формат данных (только json?).
  • Authentication
  • Versioning
  • Headers
  • Pagination (paged or limit/offset). Limits.
  • Filtering
  • Sorting
  • Query parameters
  • Errors and Messages
  • Testing
  • Localization
  • Status codes
  • Caching
  • Upload images
  • Logging (web dashboard with request/response logs)
  • Examples
  • Bad practices
  • Helpful links

About