Skip to Main Content
Documentation of REST and REST-style services often uses prose only, making it hard for client developers to understand the ties between the service's parts. We developed a notation for REST-style services that's based on UML state charts. It can be used with existing tools and is simple enough for use on whiteboards. The notation visualizes relationships between application states, thereby improving the understanding of hypermedia use in services. This benefits both service designers and client developers. Because the notation makes REST-related design problems more obvious, it might even improve service design.