Governance
Organize APIs and related artifacts into a structured hierarchy
Enable easy access to your APIs
API First
Requirement management
Governance
Design
Review
Publish
Governance of API designs establishes standards, policies, and guidelines enabling creation of consistent and standard-compliant APIs. Through API governance, organizations can enforce best practices, ensure data security, and organize APIs and artifacts effectively for easy location and usage. This helps maintain quality, reliability, and scalability in the API ecosystem.
Common Challenges in API Governance
Difficulty in finding project-related APIs.
Challenges in centrally locating APIs related to different projects.
Difficulty in locating APIs based on business functionality.
Hard to find API versions, the latest version, and ongoing versions to check API status.
Difficulty in tracking improvements and newly added features to existing APIs.
Challenges in maintaining organizational visibility levels as public or private.
Difficulty in checking API changes.
Struggles in maintaining consistency among different APIs.
Difficulty in enforcing design rules during the designing process.
Challenges in following the same API specification template across the organization's projects.
Organization and Project management
Create Public or Private Organizations
Organizations can be designated as public or private based on the need to expose APIs externally or keep them internal according to organizational requirements.
Locate APIs in Organization-Specific Catalogs
Organization-specific catalogs ensure that APIs in different projects under the same organization are stored in a common repository. This prevents duplication across projects and allows for easier management and retrieval of APIs, promoting consistency and efficiency within the organization.
Locate APIs in Project-Specific Catalogs
Project-specific catalogs allow efficient organization and retrieval of APIs related to a particular project from a common location. It reduces time spent on searches, thereby enhancing project management.
Locate API Collections by Business Functionality
API collections can be created based on business functionalities, with support for three nested layers. This hierarchical organization enables users to find APIs according to specific business needs, enhancing clarity and usability.
Locate Sharable Components in API Models
Sharable components in API models can be easily located and reused across different projects. This simplifies the process of making changes to common APIs and promotes consistency and efficiency.
API Versioning and Artifacts
API Version Representation
API versions represent a clear view of the API evolution, including the latest and ongoing changes independently. This allows users to easily check the status and history of each API version, ensuring they are up-to-date with the latest developments.
API Artifacts Representation
The API artifacts representation tracks improvements and newly added features to existing APIs. This comprehensive view helps users understand the evolution of APIs and the enhancements made over time.
Audit and History Tracking
API History View
API history view represents a changelog to efficiently observe the API evolution via status changes, assignee changes, commits, merges, and artifact creation activities. This provides a detailed account of all changes made to an API.
Kanban Ticket History View
Kanban ticket history view tracks changes to API requirements, allowing users to see the progression and updates of each requirement over time. This provides transparency and accountability in the API designing process.
Consistency and Quality Assurance
API Specification Templating
API specification templating allows organizations to use predefined templates or create their own. This ensures that all APIs follow a consistent format, facilitating easier understanding and management.
Kanban-Based Review Process
The Kanban-based review process maintains consistency among different APIs. This structured approach ensures that all APIs undergo a standardized review, promoting uniformity and quality.
Style-Guide-Based Validations
Style-guide-based validations enforce design rules during the API designing process. This feature ensures that all APIs adhere to predefined standards, enhancing consistency and reducing errors.
API Import and Integration
API Import
API importing facilitates the onboarding of a large set of existing APIs to the platform. This simplifies the transition to a new system, making it easier to integrate and manage numerous APIs.
Git Integration
Git integration allows for the import of a large set of APIs directly from Git repositories. This streamlines the process of incorporating existing APIs into the platform, promoting simple integration and efficient management.
