Chapter 4. Service design and documentation policies

This chapter covers

  • Making your services self-documenting
  • Reusing existing standards and definitions
  • Increasing service reusability
  • Versioning your services

If you want to create services that can be easily used by your consumers, you need to provide good documentation and versioning strategies. If you don’t have these in place, you’ll either not get anybody to use your service or, with the first upgrade, scare your existing consumers away with breaking changes. When you keep good documentation, versioning, and reuse in mind during the development phase of your service, you make it a lot easier on your consumers; they have a clear set of documentation on how your service should be used ...

Get SOA Governance in Action now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.