ba-sequence-spec

Generating sequence diagrams and API specs from a UI specification requires screen lists, user flow descriptions, and an ERD as inputs. The tool analyzes these to produce Mermaid sequence diagrams and detailed API contracts, ensuring consistency across user, frontend, backend, and partner interactions.

The best way to derive API contracts from an ERD and screen flows is by cross-referencing screen requirements with the ERD to infer data sources. The generated API specification includes detailed field mappings based on the provided ERD, ensuring accurate data contracts.

No, the generated sequence diagrams do not include database objects. The tool explicitly omits database entities to focus strictly on the interactions between User, Frontend, Backend, and external partners within the happy path flow.

Yes, you can export the generated API specification and sequence diagram to a Word document. The tool uses the python-docx dependency to convert the primary Markdown file into a .docx format for offline review and team collaboration.

Intermediate analysis is handled by saving a separate draft Markdown file containing the intermediate reasoning. This draft management feature allows business analysts to review the derivation process alongside the primary sequence diagram and API spec files.