Upgrade to Pro — share decks privately, control downloads, hide ads and more …

API Documentation

Sponsored · Your Podcast. Everywhere. Effortlessly. Share. Educate. Inspire. Entertain. You do you. We'll handle the rest. →
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
380

Other Decks in Programming

See All in Programming
Datadog × OpenTelemetry 入門と実践のあいだ
Avatar for Max Kento kn_to_maxpno
1
110
AI時代のUIはどこへ行く？その2！
Avatar for Yusuke Wada yusukebe
19
6.2k
The Arts and Crafts of Work in the AI Era — Toward Mastery in Software Development
Avatar for Yoshihito Kuranuki / 倉貫義人 kuranuki
1
700
TSKaigi 2026 TypeScriptバックエンドのオブザーバビリティ戦略 — Datadog × NestJSの実践
Avatar for Taisei Yamamoto taiseiyamamotoan
1
210
タクシーアプリ『GO』の バックエンド開発のおける AI利活用と若者のすべて
Avatar for Kazuhiko Yamashita pyama86
3
1.8k
AIエージェントと協働するCLI開発 — BunとOpenClawで学んだこと
Avatar for よしこ yoshikouki
1
230
Swiftのレキシカルスコープ管理
Avatar for kntk kntkymt
0
210
Moments When Things Go Wrong
Avatar for Aurimas Liutikas aurimas
3
140
正しくソフトウェアを作る、前提を疑うための認知の視点 / doubt-premise
Avatar for MinoDriven minodriven
13
4.5k
肥大化するレガシーコードに立ち向かうためのインターフェース分離と依存の逆転 / JJUG CCC 2026 Spring
Avatar for hirokuni-maeta hirokunimaeta
0
390
inferと仲良くなる10分間
Avatar for ryokatsuse ryokatsuse
1
330
3Dシーンの圧縮
Avatar for Fadis fadis
1
570

Featured

See All Featured
[RailsConf 2023] Rails as a piece of cake
Avatar for Vladimir Dementyev palkan
59
6.6k
The Mindset for Success: Future Career Progression
Avatar for Greg Gifford greggifford
PRO
0
350
What's in a price? How to price your products and services
Avatar for Michael Herold michaelherold
247
13k
More Than Pixels: Becoming A User Experience Designer
Avatar for Michelle Schulp Hunt marktimemedia
3
430
Optimising Largest Contentful Paint
Avatar for Harry Roberts csswizardry
37
3.7k
Performance Is Good for Brains [We Love Speed 2024]
Avatar for Tammy Everts tammyeverts
12
1.7k
Why You Should Never Use an ORM
Avatar for John Nunemaker jnunemaker
PRO
61
9.9k
Rebuilding a faster, lazier Slack
Avatar for samanthasiow samanthasiow
85
9.5k
Impact Scores and Hybrid Strategies: The future of link building
Avatar for Tamara Novitovic tamaranovitovic
0
300
世界の人気アプリ100個を分析して見えたペイウォール設計の心得
Avatar for Akihiro Kokubo akihiro_kokubo
PRO
70
39k
The Impact of AI in SEO - AI Overviews June 2024 Edition
Avatar for Aleyda Solis aleyda
5
1.1k
Bridging the Design Gap: How Collaborative Modelling removes blockers to flow between stakeholders and teams @FastFlow conf
Avatar for Kenny Baas-Schwegler baasie
0
570

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