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

API Documentation

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
sbt 2.0: takeoff
Avatar for Eugene Yokota eed3si9n
0
160
Simple Storage Service(S3) is not simple
Avatar for Yura Iwatsuka iwatsukayura
0
290
コードレビューのボトルネックを"する側"と"される側"の両面から解消する
Avatar for yub0n yub0n
2
1.6k
Long Living Tokens, Die, Die, Die! (or: The One Ring is Banned in Modern)
Avatar for sylph01 sylph01
0
320
re:Inventに行く前に知っておきたい現地参加のノウハウ
Avatar for nokomoro3 nokomoro3
0
430
AI時代のコードレビューは人に向けるな、仕組みに向けろ
Avatar for meijin texmeijin
5
3.7k
C#の現在地 進化の歴史と、AI時代の.NET Everywhere
Avatar for Yoshifumi Kawai neuecc
5
5.2k
IBM Bob でAI駆動開発『QC-Playbook』
Avatar for 1kano ichirokano2
0
110
Optunaを作ったときにやりたかったこと、その後 (2026/10/16, Optuna Meetup #3)
Avatar for Takuya Akiba iwiwi
1
440
コーディング自動化の次へ。人の介入をゼロにするファクトリーとサポートAIによる実践
Avatar for Seiji Takahashi timakin
5
3.8k
Jetpack Compose Mechanisms
Avatar for Jaewoong skydoves
3
820
IBM Bob Dojo #1 仕様駆動開発入門
Avatar for Akira Onishi (IBM) oniak3ibm
PRO
0
390

Featured

See All Featured
How to make the Groovebox
Avatar for あそなす asonas
2
2.5k
Improving Core Web Vitals using Speculation Rules API
Avatar for Sergey Chernyshev sergeychernyshev
21
1.7k
Lightning talk: Run Django tests with GitHub Actions
Avatar for Sarah Abderemane sabderemane
0
300
First, design no harm
Avatar for Per Axbom axbom
PRO
2
1.3k
Designing for humans not robots
Avatar for Tammie Lister tammielis
254
26k
Become a Pro
Avatar for Speaker Deck speakerdeck
PRO
31
6.3k
What Being in a Rock Band Can Teach Us About Real World SEO
Avatar for Ade Holder 427marketing
0
1.1k
Fashionably flexible responsive web design (full day workshop)
Avatar for Andy Clarke malarkey
409
67k
State of Search Keynote: SEO is Dead Long Live SEO
Avatar for Ryan Jones ryanjones
0
320
New Earth Scene 8
Avatar for Sydney Stone popppiees
4
2.7k
How to build a perfect <img>
Avatar for Jono Alderson jonoalderson
1
6.1k
Reality Check: Gamification 10 Years Later
Avatar for Sebastian Deterding codingconduct
0
2.3k

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