Cyclopt Server serves as the backbone of the Cyclopt platform, providing essential APIs for managing software projects. It collects data, triggers code analyses, and integrates with external services, empowering teams to enhance software quality effectively and streamline project workflows.
Cyclopt Server serves as the central API backend for the Cyclopt platform, dedicated to enhancing software quality and effective project management. This mature backend solution offers an array of RESTful endpoints designed for:
The Cyclopt Server is the foundational component of the Cyclopt ecosystem, responsible for orchestrating multiple submodules according to the specific environment configuration, promoting efficient data flow and enhanced user experience.
Cyclopt Server is designed to:
VCS Webhook → Server → RabbitMQ → Cyclopt Analyzers → MongoDB → Server →
├─ Panorama (dashboards)
└─ Communication Service → Companion (notifications)
flowchart LR
A["Webhook (GitHub/GitLab/Bitbucket/Azure)"] --> B[Server]
B --> C[RabbitMQ]
C --> D["Cyclopt Analyzers"]
D --> E[(MongoDB)]
D --> F[(Google Cloud Storage)]
E --> G["Server (post-analysis router)"]
F --> G["Server (post-analysis router)"]
G --> H[Panorama UI]
H --> I[Communication Service]
I --> J[Companion UI]
Cyclopt Server is built upon a robust technology stack that includes:
Cyclopt Server provides multiple API endpoints under the /api/ prefix, which are secured by JWT authentication. Clients can authenticate using either a cookie (_cyclopt=<token>) or a header (Authorization: Bearer <token>).
GET /api/projects - Lists all projects available.POST /api/projects - Creates a new project.GET /api/projects/:id/analyses - Fetches analysis results for a specific project.To generate static API documentation, ensure apidoc comments are present in the code and run:
npm run buildDoc
Open the generated files located in the doc/ directory for detailed usage instructions.
No comments yet.
Sign in to be the first to comment.