@@ -54,31 +54,6 @@ streamlining development workflows.
54544 . ** Enforce Consistency** :
5555 - Use the spec to drive all API-related workflows, ensuring backend, frontend, and data teams are in sync.
5656
57- ### Use Cases
58-
59- 1 . ** API-Driven Applications** :
60- - Create consistent and versioned REST APIs with type-safe clients and server contracts.
61- - Ensure changes to your APIs don’t break downstream systems or clients.
62-
63- 2 . ** Data Validation Workflows** :
64- - Leverage ** JSON Schemas** for validating complex data structures across services and teams.
65- - Seamlessly integrate validation into pipelines for ETL processes or data ingestion workflows.
66-
67- 3 . ** Microservices and Distributed Systems** :
68- - Maintain uniform contracts across services, reducing integration bugs.
69- - Use diffing tools to communicate API changes across teams.
70-
71- 4 . ** Frontend-Backend Synchronization** :
72- - Use generated type-safe clients to keep your frontend perfectly aligned with backend APIs.
73- - Integrate tools like React Query or Vue for a seamless developer experience.
74-
75- By centralizing and automating these workflows, Contractual ensures teams stay aligned, efficient, and confident in
76- their API and data design processes.
77-
78- A ** spec-first approach** puts the definition of APIs and schemas at the center of the workflow, treating the
79- specification as the ** source of truth** . This ensures alignment across frontend, backend, and data teams while
80- streamlining development workflows.
81-
8257## 🚀 In Practice
8358
8459### Install Contractual
@@ -191,6 +166,31 @@ Here’s a short video showing contract generation in action:
191166</div >
192167```
193168
169+ ### Use Cases
170+
171+ 1. **API-Driven Applications**:
172+ - Create consistent and versioned REST APIs with type-safe clients and server contracts.
173+ - Ensure changes to your APIs don’t break downstream systems or clients.
174+
175+ 2. **Data Validation Workflows**:
176+ - Leverage **JSON Schemas** for validating complex data structures across services and teams.
177+ - Seamlessly integrate validation into pipelines for ETL processes or data ingestion workflows.
178+
179+ 3. **Microservices and Distributed Systems**:
180+ - Maintain uniform contracts across services, reducing integration bugs.
181+ - Use diffing tools to communicate API changes across teams.
182+
183+ 4. **Frontend-Backend Synchronization**:
184+ - Use generated type-safe clients to keep your frontend perfectly aligned with backend APIs.
185+ - Integrate tools like React Query or Vue for a seamless developer experience.
186+
187+ By centralizing and automating these workflows, Contractual ensures teams stay aligned, efficient, and confident in
188+ their API and data design processes.
189+
190+ A **spec-first approach** puts the definition of APIs and schemas at the center of the workflow, treating the
191+ specification as the **source of truth**. This ensures alignment across frontend, backend, and data teams while
192+ streamlining development workflows.
193+
194194## 📃 Goals
195195
196196* Provide a centralized tool for managing OpenAPI and JSON Schema lifecycles.
0 commit comments