Page MenuHomeDevCentral

Provide an API module
ClosedPublic

Authored by dereckson on Sep 4 2018, 14:57.
Tags
None
Referenced Files
F10809147: D1663.diff
Sun, Jul 27, 11:07
Unknown Object (File)
Fri, Jul 11, 00:38
Unknown Object (File)
Thu, Jul 10, 19:56
Unknown Object (File)
Jun 23 2025, 21:06
Unknown Object (File)
Jun 23 2025, 10:48
Unknown Object (File)
Jun 23 2025, 07:41
Unknown Object (File)
Jun 22 2025, 13:37
Unknown Object (File)
Jun 22 2025, 13:27
Subscribers
None

Details

Summary

API replies in REST API tend to be:

  • JSON representations of objects from a datasource, or a calculation
  • Failures with relevant status code (400, 403, 404, 409, 500, etc.)

This module provides traits to consume values and get such API response.

It provides trait implementation for Diesel QueryResult, so you can do
something like this:

pub fn get_player(connection: DatabaseConnection, name: String) -> ApiJsonResponse<Player> {
    players
        .filter(username.eq(&name))
        .first::<Player>(&*connection)
        .into_json_response()
}

This will produce a JSON representation when the result is found,
a 404 error when no result is found, a 500 error if there is a database issue.

Diff Detail

Repository
rLF Limiting Factor
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

dereckson created this revision.
This revision is now accepted and ready to land.Sep 4 2018, 14:58
This revision was automatically updated to reflect the committed changes.