Upgrade to Pro — share decks privately, control downloads, hide ads and more …
Sign up for free

API Documentation

Sponsored · SiteGround - Reliable hosting with speed, security, and support you can count on. →
Avatar for Pedram Negahdar Pedram Negahdar
June 03, 2015
Programming
350
0

API Documentation

API RESTful Documentation

Avatar for Pedram Negahdar

Pedram Negahdar

June 03, 2015

More Decks by Pedram Negahdar

See All by Pedram Negahdar
RESTful API Desgin
Avatar for Pedram Negahdar pedramn
0
370
Django/Python Test
Avatar for Pedram Negahdar pedramn
0
390

Other Decks in Programming

See All in Programming
Domain-Driven Transformation
Avatar for Henning Schwentner hschwentner
2
2.3k
Next.js: The final boss of Web Performance
Avatar for Estela Franco guaca
0
260
FactoryBotをやめればRSpecは速くなるのか？
Avatar for nissyi yuta_onishi_97
0
560
JAWS-UG 東京支部が始める、JAWS-UG支部コラボ / JAWS-UG lunchtime LT Collaboration
Avatar for y-ohgi y0hgi
0
280
Agents on Rails - Rails at Scale 2026
Avatar for Irina Nazarova irinanazarova
0
560
Verilogで学ぶCPU自作入門
Avatar for uyuki uyuki234
8
4.1k
現場と育てるRailsモデリング 〜Spreadsheetから始めたモデル設計〜
Avatar for siroemk siroemk
2
600
phperだってパンチカードでコーディングしたい
Avatar for hideki kinjyo o0h
PRO
0
340
残高管理から台帳サービスへの進化
Avatar for kobaryo artoy
1
200
Rでドレミ/Do-Re-Mi_with_R
Avatar for florets1 florets1
0
130
コードレビューのボトルネックを"する側"と"される側"の両面から解消する
Avatar for yub0n yub0n
2
1.6k
Kotlinの15年とServer-Side Kotlin
Avatar for Takehata Naoto n_takehata
1
150

Featured

See All Featured
Marketing to machines
Avatar for Jono Alderson jonoalderson
1
5.9k
Accessibility Awareness
Avatar for Sarah Abderemane sabderemane
1
250
Let's Do A Bunch of Simple Stuff to Make Websites Faster
Avatar for Chris Coyier chriscoyier
508
140k
The #1 spot is gone: here's how to win anyway
Avatar for Tamara Novitovic tamaranovitovic
4
1.2k
Color Theory Basics | Prateek | Gurzu
Avatar for Gurzu gurzu
1
490
SEOcharity - Dark patterns in SEO and UX: How to avoid them and build a more ethical web
Avatar for Sara Fernández Carmona sarafernandez
0
300
Designing Dashboards & Data Visualisations in Web Apps
Avatar for Des Traynor destraynor
232
55k
Fashionably flexible responsive web design (full day workshop)
Avatar for Andy Clarke malarkey
409
67k
Dealing with People You Can't Stand - Big Design 2015
Avatar for Cassini Nazir cassininazir
367
27k
Java REST API Framework Comparison - PWX 2021
Avatar for Matt Raible mraible
34
9.8k
Ruling the World: When Life Gets Gamed
Avatar for Sebastian Deterding codingconduct
0
400
Responsive Adventures: Dirty Tricks From The Dark Corners of Front-End
Avatar for Vitaly Friedman smashingmag
254
22k

Transcript

  1. P E D R A M N E G A

    H D A R API Documentation

  2. Developers —  Want to try your API before they write

    code. —  They want to explore data/functionality you provide. —  Want accurate, clear, concise and up-to-date information.

  3. SWAGGER —  Powerful framework for making representation of your RESTful

    API. —  High quality documentation will elevate the APIs quality. —  Annotate code, and it creates documentation for you. —  Creates a web client to try your API’s