Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.19 KB

APIv1.md

File metadata and controls

18 lines (13 loc) · 1.19 KB

API v1

ℹ️ This is the documentation for the new API. This API is still in development and though the finished endpoints should not change please consider that breaking changes may occur once its properly released. If you are looking for the current API, please see here.

The new API is an ongoing effort to migrate the current API to a more modern and standard API.

The main goals of this new API are:

  • Ease of development
  • Use of a modern framework
  • Use of a standard API specification
  • Self-documented API using Swag
  • Improved authentication and sessions using JWT
  • Deduplicate code between the webserver and the API by refactoring the logic into domains
  • Improve testability by using interfaces and dependency injection

The current status of this new API can be checked here.

Since the API is self-docummented, you can check the API documentation by running the server locally and visiting the /swagger/index.html endpoint.