Qubership APIHUB (QS-APIHUB) is a comprehensive solution designed to achieve the following goals:
- Increase quality and completeness of API documentation
- Provide a single point of truth for API Documentation
- Integrate the product into existing workflows to boost productivity
- Automate API backward compatibility validation with possibility to integrate it into CI/CD pipeline
It provides the following features
- Product API Catalog with versioning
- Rest API Support
- Import API from Swagger 2 / OpenApi 3.x
- Compare API
- Backward compatibility check
- Deprecated API tracking
- GraphQL support (beta)
The API Registry is a backend component that serves as a centralized repository for storing and managing API data. It stores API operations, documentation, metadata, and other relevant information.
Builder Service is responsible for validating and transforming uploaded API documents into a unified format. It supports various API document formats, such as Swagger, OpenAPI and GraphQL.
See qubership-apihub-build-task-consumer
The Web Portal provides a user-friendly interface for interacting with the API Registry and accessing API documentation. It offers features such as search functionality, documentation browsing.