app-state-diagram is a tool that visualizes state transitions and information structures of RESTful applications. It generates interactive state diagrams and hyperlinked documentation from ALPS (Application-Level Profile Semantics) profiles written in XML or JSON.
- Application Overview: Visually grasp complex RESTful applications and understand the big picture
- Clear Information Semantics: See how data flows and what each element means
- Enhanced Team Communication: Both technical and business teams can discuss using the same visual representation
- Design Consistency: Represent application structures uniformly and discover design issues early
app-state-diagram embodies the three key aspects of Information Architecture (IA):
- Ontology: Defines the semantic meaning of application elements and their relationships
- Taxonomy: Organizes information into structured hierarchies and classifications
- Choreography: Describes interaction patterns and rules for state transitions
By focusing on these IA principles, app-state-diagram helps create a shared understanding of application semantics across organizational boundaries, independent of specific implementation technologies.
brew install alps-asd/asd/asd
After installation, run:
asd --watch path/to/your/profile.json
See these live demos:
For more details, please refer to: