Summary dos outros métodos

Olá, Danielle

Compreendo que você gostaria de ver um exemplo de como ficariam os summaries dos outros métodos em .NET.

Os summaries são uma ótima maneira de documentar o código e fornecer informações úteis sobre o que cada método faz. Eles são especialmente úteis em uma API, pois podem ser usados para gerar documentação automática.

Vamos ver como poderiam ser os summaries para os métodos que usamos nos verbos HTTP que foram mencionados na aula:

/// <summary>
/// Cria um novo recurso no sistema.
/// </summary>
[HttpPost]
public IActionResult Create(Resource resource) {...}

/// <summary>
/// Recupera dados do sistema.
/// </summary>
[HttpGet]
public IActionResult Get() {...}

/// <summary>
/// Atualiza um recurso no sistema.
/// </summary>
[HttpPut("{id}")]
public IActionResult Update(int id, Resource resource) {...}

/// <summary>
/// Atualiza parcialmente um recurso no sistema.
/// </summary>
[HttpPatch("{id}")]
public IActionResult PartialUpdate(int id, JsonPatchDocument<Resource> patchDoc) {...}

/// <summary>
/// Deleta um recurso no sistema.
/// </summary>
[HttpDelete("{id}")]
public IActionResult Delete(int id) {...}

Lembre-se de que os summaries devem ser informativos e descrever o que o método faz de forma concisa. Espero ter ajudado e bons estudos!