add controllers docs

This commit is contained in:
Вячеслав 2025-04-27 15:58:51 +05:00
parent bfcba0beb7
commit fb3320fe18
4 changed files with 55 additions and 0 deletions

View file

@ -7,17 +7,25 @@ using SurveyLib.Core.Services;
namespace SurveyBackend.Controllers;
/// <inheritdoc />
[ApiController]
[Route("api/surveys/{surveyId}/questions")]
public class QuestionController : ControllerBase
{
private readonly IQuestionService _questionService;
/// <inheritdoc />
public QuestionController(IQuestionService questionService, IUserContext userContext)
{
_questionService = questionService;
}
/// <summary>
/// Возвращает список вопросов из опроса по его ID
/// </summary>
/// <remarks>Получение вопросов по ID опроса. В случае отсутствия опроса с таким идентификатором выкидывает 404</remarks>
/// <param name="surveyId"></param>
/// <returns></returns>
[AllowAnonymous]
[HttpGet]
[ProducesResponseType(StatusCodes.Status404NotFound)]
@ -29,6 +37,13 @@ public class QuestionController : ControllerBase
return Ok(result);
}
/// <summary>
/// Добавить вопрос к опросу
/// </summary>
/// <remarks>К опросу с указанным ID добавляет вопрос. Если я правильно написал, при отсутствии такого опроса кинет 404</remarks>
/// <param name="dto"></param>
/// <param name="surveyId"></param>
/// <returns></returns>
[Authorize]
[HttpPost]
[ProducesResponseType(StatusCodes.Status404NotFound)]