Search icon CANCEL
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Conferences
Free Learning
Arrow right icon
Arrow up icon
GO TO TOP
RESTful Java Web Services, Second Edition

You're reading from   RESTful Java Web Services, Second Edition Design scalable and robust RESTful web services with JAX-RS and Jersey extension APIs

Arrow left icon
Product type Paperback
Published in Sep 2015
Publisher
ISBN-13 9781784399092
Length 354 pages
Edition 1st Edition
Languages
Arrow right icon
Author (1):
Arrow left icon
Jobinesh Purushothaman Jobinesh Purushothaman
Author Profile Icon Jobinesh Purushothaman
Jobinesh Purushothaman
Arrow right icon
View More author details
Toc

Table of Contents (11) Chapters Close

Preface 1. Introducing the REST Architectural Style FREE CHAPTER 2. Java APIs for JSON Processing 3. Introducing the JAX-RS API 4. Advanced Features in the JAX-RS API 5. Introducing the Jersey Framework Extensions 6. Securing RESTful Web Services 7. The Description and Discovery of RESTful Web Services 8. RESTful API Design Guidelines A. Useful Features and Techniques Index

Documenting RESTful web APIs


Good API documentation improves the market adoption of APIs. The API documentation should be both human and machine readable. There are many tools available today for documenting RESTful web APIs. Some of the popular RESTful web API documentation tools are listed here for your quick reference:

  • WADL: This tool is an XML description of HTTP-based web applications such as RESTful web services. Not many vendors use WADL nowadays due to the emergence of more developer-friendly API documentation tools such as Swagger, RAML, and API Blueprint. To learn more about the WADL specification, visit http://www.w3.org/Submission/wadl.

  • RAML: This tool provides both human- and machine-readable formats (YAML) for describing APIs. This is relatively new in the market and is well supported by the active open source community. To learn more about RAML, visit the official site at http://raml.org.

  • Swagger: This tool allows you to define APIs either in YAML or JSON and is backed up...

lock icon The rest of the chapter is locked
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at €18.99/month. Cancel anytime