https://github.com/netcracker/qubership-apihub
https://github.com/netcracker/qubership-apihub
apihub qubership-apihub
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/netcracker/qubership-apihub
- Owner: Netcracker
- License: apache-2.0
- Created: 2024-12-24T12:11:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-26T10:07:34.000Z (6 months ago)
- Last Synced: 2025-12-27T22:09:06.355Z (6 months ago)
- Topics: apihub, qubership-apihub
- Language: Shell
- Homepage:
- Size: 4.7 MB
- Stars: 12
- Watchers: 7
- Forks: 5
- Open Issues: 182
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Qubership APIHUB
**Qubership APIHUB** (QS-APIHUB) is a comprehensive solution designed to achieve the following goals:
1. Increase quality and completeness of API documentation
1. Provide a single point of truth for API Documentation
1. Integrate the product into existing workflows to boost productivity
1. 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)
## Modules
### High Level architecture
### API Registry
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.
See [qubership-apihub-backend](https://github.com/Netcracker/qubership-apihub-backend)
### Builder Service
**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](https://github.com/Netcracker/qubership-apihub-build-task-consumer)
### Web Portal
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.
See [qubership-apihub-ui](https://github.com/Netcracker/qubership-apihub-ui)
### Out of the box add ons
See [APIHUB Wiki](https://github.com/Netcracker/qubership-apihub/wiki#supplementary-applications) for APIHUB add-ons architecture
#### API Linter service
The **API Linter service** is a pluggable add-on (included into OOB delivery be default) which enrich APIHUB Portal with an ability to do linting of API specification using third-party linting engine (spectral)
See [qubership-api-linter-service](https://github.com/Netcracker/qubership-api-linter-service)
#### APIHUB Agents backend
A Go-based microservice that provides management and orchestration capabilities for [Qubership APIHUB agents](https://github.com/Netcracker/qubership-apihub-agent)
This service handles agent registration, service discovery, snapshot management, and security checks.
See [qubership-apihub-agents-backend](https://github.com/Netcracker/qubership-apihub-agents-backend)
## Documentation
### [Internal Wiki](https://github.com/Netcracker/qubership-apihub/wiki)
### Installation Guide
[Installation Guide](./docs/installation-guide.md)
### Administration Guide
[Administration Guide](./docs/admin-guide.md)
### User Guide
[User Guide](./docs/user-guide.md)