Project

General

Profile

Actions

Question #1547

closed

API: API Evolution

Added by Bernhard Koschiček-Krombholz over 3 years ago. Updated about 3 years ago.

Status:
Closed
Priority:
Normal
Category:
API
Target version:
-
Start date:
2021-07-14
Estimated time:

Description

I have read about API evolution. It is not good practice to user version numbers, either in URI nor in HTTP Headers. The best design would be to only add things and not delete anything unless it is absolutely necessary. Endpoints and json objects should be marks with a deprecation note to tell the clients that this resource is no longer up-to-date. This should give the clients time to adjust their applications. This is also supported since OpenAPI 3.0 and since 2018 for json.

This in mind I like to discuss the possiblity to remove the version part of the URL. So /api/0.2/ will be only /api/.

Before this could happen, we need to work together, to make the API understandable and easy to use.


Related issues 1 (0 open1 closed)

Precedes OpenAtlas - Feature #1549: API: deprecation of node and subunit functionsClosedBernhard Koschiček-Krombholz2021-07-15Actions
Actions

Also available in: Atom PDF