Requirement Management
Manage and prioritize your project's API needs
Aligns your APIs with design rules and industry standards.
API First
Requirement management
Governance
Design
Review
Publish
Requirement management during the API design phase is important as it sets the foundation for understanding and prioritizing stakeholder needs and project scope. By effectively managing requirements, API Designers can ensure that the resulting API aligns with business goals and user expectations. This process involves gathering, documenting, and validating requirements to guide the API specification design process.
Common Challenges in API Requirement Management
Difficulty in tracking multiple requirements of each API parallelly.
Challenges in monitoring changes to each requirement.
Struggle to differentiate API requirements as new features, improvements, or bug fixes.
Difficulty in tracking progress and details of ongoing API design efforts.
Lack of visibility to overall API-project-related activities.
Difficulty in tracking the overall API evolution.
Central requirement repository
The API requirement board is a single location to keep all documented API needs. And also the API requirement board facilitates to document API need in Kanban ticket, store them in Backlog until the ticket’s work get start, check the progress of working tickets via the Kanban board and locate the unwanted tickets in the Archive section.
Kanban Board
A visual tool to centrally track and manage API requirement progress in the form of Kanban tickets residing in various stages of completion.
Kanban Ticket
A card representing a specific API requirement or task. Each Kanban ticket contains details about the requirement, including its description, priority, assignee, and any relevant notes. Kanban tickets move through different stages on the Kanban board as work progresses, allowing project members to see the status and flow of work.
Backlog
A holding area for all API requirements and tasks that are yet to be started. The backlog serves as a repository for all upcoming work, allowing project members to prioritize and plan tasks before they move to active designing.
Archive
A section where completed or no longer needed API requirements and tasks are stored. The archive provides a historical record of past work and decisions, ensuring that unwanted or finished tickets are kept for reference without cluttering the active workspaces.
Intuitive requirement classification
API requirements can be easily categorized based on the business perspective of the API enhancements using following Kanban ticket types:
Feature
A feature refers to an addition to the existing functionality of the API. This could include adding new endpoints, introducing new parameters, improving response times, or implementing new capabilities that were not previously available. A feature expands the capabilities or usability of the API.
Improvement
An improvement in API refers to enhancements or optimizations made to the existing API infrastructure or functionality. This could involve improving the performance, reliability, security, or scalability of the API without necessarily adding new features. Improvements are focused on making the API better in some way, such as reducing latency, enhancing error handling, or optimizing resource usage.
Bug Fixer
A bug fixer is a corrective action taken to resolve bugs within the API. Bugs can cause unexpected behavior, errors, or vulnerabilities in the API's functionality. Bug fixers involve identifying and addressing bugs to ensure that the API operates as intended.
All the Essential Information Representation
The Kanban ticket represents all the essential information that is needed to drive API specification from scratch to robust end. Kanban ticket can link with an API specification, log the requirement evolution and track the progress of API designing process.
Exclusive project view
The project representation includes a catalog and a [Kanban board]-> (link to previous section explanation) specific to each project. Additionally, project-based integration management and style guide applications simplify project management. All project-related activities can be easily tracked through the Project Activity stream.
Style guide
The style guide ensures consistency across all project APIs. It offers a set of standards for designing APIs, helping team members maintain a uniform look and feel.
Catalog
The catalog serves as a comprehensive repository for all project-related APIs. It enables members to quickly access APIs they need, reducing the time spent searching for API artifacts and enhancing overall project efficiency.
Integration
Project-based integration management facilitates seamless connectivity between various tools and systems used in the project. Effective integration enhances collaboration and ensures all team members work with the most up-to-date information.
Activity stream
The Project Activity stream provides a real-time feed of all project-related activities, offering a transparent view of progress and updates.
API history view
An API history view display a changelog to efficiently observe the API evolution via API status changes, assignee changes, commits, merges, and API artifact creations.
Links added to an API commit
The links added to the API commit refer to the associated URLs, and allow project members to efficiently review the requirements and context of the committed changes.
