DefGuard / DefGuard/defguard

Separate REST API endpoints from Web UI API

Open
#3,487 0 comments 0 reactions 0 assignees View on GitHub
feature
Dominant language
Rust
Stars
2.8k
Forks
115
Avg merge
1d 4h
Merged PRs (30d)
51

Description

We keep running into issues with the API endpoints changing and the OpenAPI spec getting outdated.

Instead of trying to use the same API for integrations and to support the frontend I propose we could separate the REST API meant for automations/scripts/integrations into a dedicated namespace (probably current /api/v1) with completely separate structs (and possibly a separate crate in the future) etc.

This API would stay mostly static and have full Swagger documentation. It should probably just reflect the DB models as a starting points and not our compound structs which are necessary to service specific frontend needs.

Then the webapp could have a completely separate API which we could do whatever with and not worry about breaking compatibility or updating the docs.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.