Review
Enforce API validation using Kanban-Board-based workflows
Streamlining API Reviews for Quality Assurance and Continuous Improvement
API First
Requirement management
Governance
Design
Review
Publish
Reviews in the API design phase enable validating functionality, identifying API issues, and gathering feedback for continuous improvement. Conducting thorough reviews, including code reviews and design reviews ensures that the API meets quality standards, adheres to specifications, and aligns with business requirements. Feedback loops from reviews help refine designs, optimize performance, and enhance overall API effectiveness.
Common Challenges in API Review
Tight project schedules often force teams to bypass the proper review process.
Business requirements are hard to understand for third-party reviewers, necessitating clarification through calls and emails.
Reviewing API standard compliance manually is a difficult process.
Rechecking the entire specification after each update by designers is cumbersome.
Reviewing API specifications with many issues leads to lengthy review cycles.
Communicating required changes to designers is time-consuming.
Ensuring that reviewed items remain unchanged by designers is difficult.
Merging different features, improvements, or bug fixes into the main API is hard due to conflicts.
Tracking the review has been completed is problematic.
Keeping track of review items and items pending review is challenging.
Review Workflow Management
Kanban-Board-Based Review Process
A Kanban-board-based review process helps manage tight project schedules by visually organizing tasks, allowing teams to prioritize and follow a structured review process without bypassing essential steps.
Kanban Board Status
Kanban board status feature offers a clear visual representation of the review workflow, allowing teams to easily track review items and items that must be reviewed, ensuring nothing is overlooked.
Linking of API and Requirement in Kanban Ticket
API and its requirement documented Kanban ticket linked feature ensures that business requirements are clearly documented in a Kanban ticket and linked to an API, making it easier for third-party reviewers to understand and reducing the need for clarification through calls and emails.
Kanban-Based Ticket Assignee Tracking
Kanban-based ticket assignee tracking ensures that each review task is assigned to a specific individual, making it easy to track responsibility and progress of reviews.
Holistic View of Items in Review in Progress and Done Statuses
The project dashboard provides a holistic view of ‘Done’ items and ‘Review in Progress' items in the project dashboard provides a comprehensive overview of the review status, helping teams keep track of both completed and pending review tasks.
Automated Validation and Compliance
Open API Specification-3.1.0-Based Diagnostics Validation
Open API-Specification-3.1.0-based diagnostics validation ensures that APIs adhere to the latest standards, facilitating automatic checks and validations against the specification to streamline the review process.
Style guide-Based Diagnostics Validation
Style guide-based diagnostics validation automates the application of technical standards to API designs, ensuring compliance and consistency, and alleviating the burden of manual review against these standards. Also it helps to eliminate errors during the design process, reducing the number of issues that need to be reviewed later and shortening review times.
Effective Communication and Change Management
Diff View to Compare Selected Versions and Commits
Diff view enabling comparing selected versions and commits allows reviewers to easily identify changes between different versions of the API specification, simplifying the rechecking process after each update by designers.
In-Line Commenting for Transparent Communication
In-line commenting allows communicating with relevant parties in a very transparent manner, allowing reviewers to leave specific feedback and suggestions directly within the API specification, making communication clear and efficient.
Restricting changes to 'Done' API specifications
Reviewers can update the API status to 'Done' to lock the specification. The system restricts changes on 'Done' status APIs, ensuring that once an API has passed the review process, it remains unchanged.
Conflict Resolution
Xapi effectively handles conflicts that may arise when merging different features, improvements, or bug fixes into the main API, ensuring smooth integration of changes.
Review Tracking and History
API Activity Logging
API activity logging tracks all actions performed on the API specification, including reviews, updates, and status changes, providing a clear audit trail that makes it easy to identify who is responsible for reviewing items and whether the reviews have been completed.
