Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Design First Web APIs - OpenAPI 3
Search
Roger Camargo
June 02, 2021
Programming
1
58
Design First Web APIs - OpenAPI 3
Design first web APIs and why Django did not help!
Roger Camargo
June 02, 2021
Tweet
Share
More Decks by Roger Camargo
See All by Roger Camargo
Mapa de estudo dev frontend 2023
huogerac
1
44
Documentando API no Django com django-ninja
huogerac
1
58
Um pouco da origem para chegar no WSGI
huogerac
0
14
"API Design First" pt-br
huogerac
0
190
3 Arquiteturas Django
huogerac
1
150
Django ORM vs SQLAlchemy (queries)
huogerac
0
130
Django ORM vs SQLAlchemy (intro)
huogerac
0
57
Site Imobiliario Django
huogerac
0
67
CMS Django com magic content
huogerac
0
80
Other Decks in Programming
See All in Programming
Enhancing Applications with Accessibility API
kishikawakatsumi
3
990
Go1.22からの疑似乱数生成器について/go-122-pseudo-random-generator
convto
1
160
PHP8の機能を使って堅牢にコードを書く
fendo181
6
2.6k
Crafting a Own PHP - ウキウキ手作りミニマリストPHP
uzulla
4
1.1k
脱・初心者!脱・マネコン!AWS CDKを使ってみませんか!?
har1101
0
160
LPIXEL×CADDi_kaerururu
kaerururu
3
300
オブジェクト指向コードレビューの新しいアプローチ
akkie76
3
1.5k
Parallel Socket Communication in Swift
s_shimotori
0
250
Some Quick Ideas To Improve Your Tests ( #jassttokyo )
teyamagu
PRO
2
2.3k
AppDeveloperCon 2024 EU: Building polyglot developer experiences in 2024
salaboy
0
380
OpenAPI を守るのは難しい
ohmori_yusuke
1
140
RubyVM を PHP で実装する 〜Hello World を出力するまで〜
memory1994
PRO
1
490
Featured
See All Featured
Imperfection Machines: The Place of Print at Facebook
scottboms
257
12k
The Language of Interfaces
destraynor
150
23k
Practical Orchestrator
shlominoach
180
9.7k
Fashionably flexible responsive web design (full day workshop)
malarkey
397
65k
How to train your dragon (web standard)
notwaldorf
71
5.1k
Making Projects Easy
brettharned
106
5.4k
Being A Developer After 40
akosma
56
580k
Done Done
chrislema
178
15k
YesSQL, Process and Tooling at Scale
rocio
160
13k
Documentation Writing (for coders)
carmenintech
59
3.8k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
24
2.2k
Code Review Best Practice
trishagee
54
15k
Transcript
Design first APIs and why Django did not help! by
Roger Camargo - Jun/2021
Design first APIs and why Django did not help! WEB
by Roger Camargo - Jun/2021
DISCLAIMER
Why API?
Backend Data Frontend API Code is the documentation. (It’s okay)
👉
Backend Data Client 1 API Client 2 Where is the
API documentation? 👉
Backend Data Client 1 API System A SDK Client JS
System B Client 2
Backend Data Client 1 API Client 2 System A SDK
Client JS System B Internet It can be hard to keep an API documentation updated... 👉
How to use your API? What are the endpoints? Methods?
Status codes??
How to use your API? What are the endpoints? Methods?
Status codes?? https://http.cat/
/users Code-First, Write Docs "When We Have Time" 👉 It
means "We will not write documentation"
201 API Specs/Docs
👉 It can fail to maintain parity between our documentation
and our underlying implementation API Specs/Docs
OpenAPI Specification (OAS3)
What is OAS3? - Contract for defining RESTful APIs -
Source of truth for everyone - Open source, evolving standard - Collection of tools - Language-agnostic - Readable by both humans and machines
What is OAS3? - Design by contract (YAML) (The pragmatic
programmer) - Get feedback on the API before coding - Easier to make changes - One source of truth - Generate code, mock, tests, docs etc...
Wait... Big design up front?
https://editor.swagger.io/ 👉 One source of truth
https://github.com/zalando/connexion 👉
Low coupling, High cohesion
api.py YAML service.py (CONTRACT) Routes Request validation Response validation Schema
casting FACADE API Layer Business Layer DATA ORM
Django land...
Models Managers TEMPLATE FILTERS Exception Middlewares View Exception Handlers
/polls/
Django It’s hard to produce API Guided by the YAML
contract...
However, there is django-ninja DOCS Code first, but there is
an API documentation 👉
The design first way… (Flask, Falcon etc…)
Automatic live documentation API Mock server Frontend For quick UX
validation Quick feedback Frontend TEAM Backend TEAM Real Implementation API Tests Business Tests Minimize the ReWork YAML
Design first API Links: https://swagger.io/resources/webinars/adopting-a-design-first-approach/ https://apisyouwonthate.com/blog/api-design-first-vs-code-first https://docs.djangoproject.com/en/3.2/ref/request-response/ https://www.openapis.org/ https://github.com/zalando/connexion https://http.cat/
Tools: https://editor.swagger.io/ https://stoplight.io/ Code sample: https://github.com/billcode/jarless Books https://www.goodreads.com/book/show/4099.The_Pragmatic_Programmer
THANK YOU Keep in touch @huogerac https://huogerac.hashnode.dev
[email protected]
https://speakerdeck.com/huogerac