warren830 opened a new issue, #4842: URL: https://github.com/apache/incubator-devlake/issues/4842
## What and why to refactor Currently, our API endpoints are not consistent in their structure. Some endpoints have only the domain, while others include common suffixes (such as version numbers) or even additional common prefixes shared by all API endpoints. This inconsistency can lead to confusion and make it harder to maintain and understand the API. Refactoring the API endpoints to follow a consistent structure would improve readability, maintainability, and make it easier for developers to work with the API. ## Describe the solution you'd like We should standardize the structure of our API endpoints. Either limit all endpoints to the domain or use the longest common substring among all endpoints. This will make our API more consistent and easier to work with. For example, if we choose to include the version number in all endpoints, the structure could look like this: - `/v1/resource1` - `/v1/resource2` If we decide to use the longest common substring, it could look like this: - `/api/v1/resource1` - `/api/v1/resource2` Before implementing the changes, we should discuss and agree on a standard that works best for our use case. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
