DZone
Integration Zone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
  • Refcardz
  • Trend Reports
  • Webinars
  • Zones
  • |
    • Agile
    • AI
    • Big Data
    • Cloud
    • Database
    • DevOps
    • Integration
    • IoT
    • Java
    • Microservices
    • Open Source
    • Performance
    • Security
    • Web Dev
DZone > Integration Zone > Documenting RESTful APIs

Documenting RESTful APIs

API documentation is hugely essential. Learn more about RESTful API documentation in this cool talk from Andy Wilkinson.

Pieter Humphrey user avatar by
Pieter Humphrey
CORE ·
Jan. 20, 16 · Integration Zone · Analysis
Like (10)
Save
Tweet
9.02K Views

Join the DZone community and get the full member experience.

Join For Free

An API’s documentation is a vital part of making it easy to understand and easy to use. RESTful APIs are no different. In this talk we’ll look at what should be included in your RESTful API’s documentation and, just as importantly, what should be omitted. Using real-word examples, both good and bad, we’ll discuss how the documentation should be structured so that it’s informative, succinct, and easy to read. Having identified what good documentation looks like, we’ll discuss some of the tools that are available for documenting services built using Spring. In particular, we’ll look at some of the problems and limitations of choosing a tool like Swagger and how some alternatives, including Spring REST Docs, avoid these shortcomings and help you to produce documentation that your users will love.


Recorded at SpringOne2GX 2015.

Track: Web/Javascript Track
Speaker: Andy Wilkinson
Slides: http://www.slideshare.net/SpringCentral/documenting-restful-apis

REST Web Protocols

Published at DZone with permission of Pieter Humphrey, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • What Is Cloud-Native Architecture?
  • Take Control of Your Application Security
  • 3 Pieces of Bad Advice on How to Keep Your IT Job
  • The End of the Beginning for Apache Cassandra

Comments

Integration Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • MVB Program
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends:

DZone.com is powered by 

AnswerHub logo