Battle tested API design - Laracon EU Online

Battle tested API design - Laracon EU Online

E44317a06f6ff5fec214d3f54f7ba432?s=128

Johannes Pichler

May 20, 2020
Tweet

Transcript

  1. 4.
  2. 6.

    Steps for building your API Design • Requirements & Planning

    • Implementa4on • Verifica4on & Maintenance
  3. 11.

    Rou$ng - API Versioning • frequency of endpoint changes •

    handling of breaking changes • use seman8c versioning • use only major version in URLs
  4. 12.

    Response format • no custom response format • use a

    defined standard • JSON:API • HAL
  5. 14.

    API Specifica,on • use an API client like Stoplight Studio

    or Postman • define your endpoints with edge cases • make your specifica;on testable
  6. 17.

    Verifica(on • it's all about metrics • have useful error

    logging in place • verify your assump7ons during development
  7. 18.

    Maintenance • be careful with breaking changes • s3ck to

    seman3c versioning • keep your API specifica3on up to date
  8. 19.