it-at-m / it-at-m/refarch

[Feature] API Versioning

Open
#704 0 comments 0 reactions 0 assignees View on GitHub
Component: API-Gateway Component: Integrations Priority: Low Type: Feature
Dominant language
Java
Stars
7
Forks
5
Avg merge
2d 4h
Merged PRs (30d)
34

Description

### Relevant component

refarch-integrations, refarch-gateway

### Problem description (optional)

Currently our artifacts do not use versioned APIs. This is bad for clients, as they will break once the API on our side changes.

### Desired solution

We should investigate Spring API versioning (https://docs.spring.io/spring-framework/reference/web/webmvc-versioning.html) and discuss whether this is relevant for us or not.

### Considered alternatives (optional)

_No response_

### Additional context (optional)

_No response_

### No duplicate

- [x] I confirm that this issue is not a duplicate

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the refarch-integrations and refarch-gateway components alongside Spring's API versioning guidance. Determine whether versioned APIs are relevant to these components, then document the recommendation and agree on an approach for handling future API changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.