AppStd/EnvelopeGenerator
8
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Enhance API documentation and error handling

Browse Source 
Updated `EnvelopeReceiverController` with additional XML documentation for HTTP response codes in key methods. Improved formatting of catch blocks and enhanced logging statements for better error context.
This commit is contained in:
Developer 02 2025-04-10 19:08:35 +02:00
parent 5715343651
commit b4ab2c4423
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
EnvelopeGenerator.GeneratorAPI/Controllers/EnvelopeReceiverController.cs
View File

@ -47,6 +47,8 @@ public class EnvelopeReceiverController : ControllerBase
/// Dieser Endpunkt ermöglicht es, Umschlagempfänger basierend auf dem Benutzernamen und optionalen Statusfiltern abzurufen. /// Dieser Endpunkt ermöglicht es, Umschlagempfänger basierend auf dem Benutzernamen und optionalen Statusfiltern abzurufen.
/// Wenn der Benutzername nicht ermittelt werden kann, wird ein Serverfehler zurückgegeben. /// Wenn der Benutzername nicht ermittelt werden kann, wird ein Serverfehler zurückgegeben.
/// </remarks> /// </remarks>
/// <response code="200">Die Liste der Umschlagempfänger wurde erfolgreich abgerufen.</response>
/// <response code="500">Ein unerwarteter Fehler ist aufgetreten.</response>
[HttpGet] [HttpGet]
public async Task<IActionResult> GetEnvelopeReceiver([FromQuery] ReadEnvelopeReceiverQuery envelopeReceiver) public async Task<IActionResult> GetEnvelopeReceiver([FromQuery] ReadEnvelopeReceiverQuery envelopeReceiver)
{ {
@ -69,7 +71,7 @@ public class EnvelopeReceiverController : ControllerBase
return StatusCode(StatusCodes.Status500InternalServerError, msg); return StatusCode(StatusCodes.Status500InternalServerError, msg);
}); });
} }
catch(Exception ex) catch (Exception ex)
{ {
_logger.LogError(ex, "An unexpected error occurred. {message}", ex.Message); _logger.LogError(ex, "An unexpected error occurred. {message}", ex.Message);
return new StatusCodeResult(StatusCodes.Status500InternalServerError); return new StatusCodeResult(StatusCodes.Status500InternalServerError);
@ -85,6 +87,9 @@ public class EnvelopeReceiverController : ControllerBase
/// Dieser Endpunkt ermöglicht es, den Namen des letzten Empfängers abzurufen, der mit der angegebenen E-Mail-Adresse verknüpft ist. /// Dieser Endpunkt ermöglicht es, den Namen des letzten Empfängers abzurufen, der mit der angegebenen E-Mail-Adresse verknüpft ist.
/// Wenn kein Empfänger gefunden wird, wird ein leerer String zurückgegeben. /// Wenn kein Empfänger gefunden wird, wird ein leerer String zurückgegeben.
/// </remarks> /// </remarks>
/// <response code="200">Der Name des Empfängers wurde erfolgreich abgerufen.</response>
/// <response code="404">Kein Empfänger mit der angegebenen E-Mail-Adresse gefunden.</response>
/// <response code="500">Ein unerwarteter Fehler ist aufgetreten.</response>
[HttpGet("receiver-name/{mail}")] [HttpGet("receiver-name/{mail}")]
public async Task<IActionResult> GetReceiverName([FromRoute] string mail) public async Task<IActionResult> GetReceiverName([FromRoute] string mail)
{ {
@ -101,7 +106,7 @@ public class EnvelopeReceiverController : ControllerBase
return StatusCode(StatusCodes.Status500InternalServerError); return StatusCode(StatusCodes.Status500InternalServerError);
}); });
} }
catch(Exception ex) catch (Exception ex)
{ {
_logger.LogError(ex, "{message}", ex.Message); _logger.LogError(ex, "{message}", ex.Message);
return StatusCode(StatusCodes.Status500InternalServerError); return StatusCode(StatusCodes.Status500InternalServerError);
@ -117,6 +122,8 @@ public class EnvelopeReceiverController : ControllerBase
/// Dieser Endpunkt ermöglicht es, geheime Informationen zu einem Umschlagempfänger basierend auf der UUID abzurufen. /// Dieser Endpunkt ermöglicht es, geheime Informationen zu einem Umschlagempfänger basierend auf der UUID abzurufen.
/// Wenn keine Informationen gefunden werden, wird ein entsprechender Fehlerstatus zurückgegeben. /// Wenn keine Informationen gefunden werden, wird ein entsprechender Fehlerstatus zurückgegeben.
/// </remarks> /// </remarks>
/// <response code="200">Die geheimen Informationen wurden erfolgreich abgerufen.</response>
/// <response code="500">Ein unerwarteter Fehler ist aufgetreten.</response>
[HttpGet("secret")] [HttpGet("secret")]
[Authorize] [Authorize]
public async Task<IActionResult> GetSecretAsync([FromQuery] string uuid) public async Task<IActionResult> GetSecretAsync([FromQuery] string uuid)