Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Sign up for free
Menu
Search
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Pricing
Search
Sign in
Sign up for free
Battle tested API design - Laracon EU Online
Search
Johannes Pichler
May 20, 2020
Programming
96
0
Share
Embed
Copy iframe code
Copy JS code
Copy link
Start on current slide
Battle tested API design - Laracon EU Online
Johannes Pichler
May 20, 2020
Transcript
21 slides
Ba#le tested API design Laracon EU Online 2020
Johannes Pichler • Web Developer since 2006 • PHP, .NET,
Java • working @ karriere.at
Agenda • API design • Implemen/ng an API in Laravel
None
API Design
Steps for building your API Design • Requirements & Planning
• Implementa4on • Verifica4on & Maintenance
Requirements & Planning
Consider the client(s)
Rou$ng • based on resources • use standard HTTP methods
• be as explicit as possible
Rou$ng GET: /todos GET: /todos/{id} POST: /todos PUT: /todos/{id} DELETE:
/todos/{id}
Rou$ng - API Versioning • frequency of endpoint changes •
handling of breaking changes • use seman8c versioning • use only major version in URLs
Response format • no custom response format • use a
defined standard • JSON:API • HAL
Authoriza*on • use specific client tokens • add access tokens
for sensi3ve endpoints
API Specifica,on • use an API client like Stoplight Studio
or Postman • define your endpoints with edge cases • make your specifica;on testable
Implemen'ng an API in Laravel
Verifica(on & Maintenance
Verifica(on • it's all about metrics • have useful error
logging in place • verify your assump7ons during development
Maintenance • be careful with breaking changes • s3ck to
seman3c versioning • keep your API specifica3on up to date
Summary
Resources • h#ps:/ /github.com/fetzi/laracon-api-design • h#ps:/ /jsonapi.org/
THANKS @fetzi_io
More Decks by Johannes Pichler
See All by Johannes Pichler
Crafting Elegant APIs with Laravel
fetzi
0
37
Crafting Elegant APIs with Laravel
fetzi
0
180
Battle tested API Design - Laravel Edition (PHP.RUHR)
fetzi
0
100
Battle tested API design
fetzi
0
110
Mastering CLIs
fetzi
0
70
(Understanding) OAuth2
fetzi
0
260
Decouple Everything
fetzi
0
230
Go Basics Workshop
fetzi
1
100
Getting more out of Git (german)
fetzi
0
86
Other Decks in Programming
See All in Programming
Python Lambdaにおけるテストしやすい設計とAI支援の活用 / Designing Testable Python Lambda Functions with AI
kitano_yuichi
1
340
우리의 Nitro Modules는 당신의 Turbo Modules보다 아름답다
l2hyunwoo
0
270
止まらない比較を止める — 余帰納法で無限ストリームを比べる
tarao
0
190
Rails初心者がパスキーを実装してみて大変だったこと
ktombow
0
210
AI駆動開発4年目の現在地(『あなたはFDEになるべきか?』イベント資料)
kumaiu
0
650
Snowflake Openflow Connector利用の勘所 / 20261024developersio2026tokyo-snowflake-openflow
kasacchiful
PRO
0
350
Debian JP Projectのサーバー構成
uwabami
1
110
Zero-Tap Sign-In対応、結局何をすればいいの?
mitohato14
0
2.3k
SODA - FACT BOOK(JP)
sodainc
1
40k
Claude Codeのおかげでやりたいことがやれるようになったんだよォー!
sms_tech
0
120
私なりのハーネスエンジニアリング ~独自の言語処理系の開発を通して~
seosoft
0
210
あなたはMCPの機能を、まだ知らない。
4geru
1
560
Featured
See All Featured
How To Speak Unicorn (iThemes Webinar)
marktimemedia
1
640
Hiding What from Whom? A Critical Review of the History of Programming languages for Music
tomoyanonymous
3
1.4k
Building a Scalable Design System with Sketch
lauravandoore
464
34k
How Software Deployment tools have changed in the past 20 years
geshan
3
35k
The Art of Programming - Codeland 2020
erikaheidi
57
14k
Digital Projects Gone Horribly Wrong (And the UX Pros Who Still Save the Day) - Dean Schuster
uxyall
2
3.9k
End of SEO as We Know It (SMX Advanced Version)
ipullrank
3
4.5k
Believing is Seeing
oripsolob
1
280
Future Trends and Review - Lecture 12 - Web Technologies (1019888BNR)
signer
PRO
0
3.8k
Money Talks: Using Revenue to Get Sh*t Done
nikkihalliwell
0
560
A brief & incomplete history of UX Design for the World Wide Web: 1989–2019
jct
2
570
Agile that works and the tools we love
rasmusluckow
331
22k