GPIC - Backend  1.0
Aplicações .NET para o backend do GPIC
Referência à classe WebAPI.Controllers.CourseController

Controller de Curso. Mais...

Diagrama de heranças da classe WebAPI.Controllers.CourseController
[legenda]
Diagrama de colaboração para WebAPI.Controllers.CourseController:
[legenda]

Membros públicos

 CourseController (IGetCourseById getById, IGetCourses getAll, ICreateCourse create, IUpdateCourse update, IDeleteCourse delete, ILogger< CourseController > logger)
 Construtor do Controller de Curso. Mais...
 
async Task< ActionResult< DetailedReadCourseOutput > > GetById (Guid? id)
 Busca curso pelo id. Mais...
 
async Task< ActionResult< IEnumerable< ResumedReadCourseOutput > > > GetAll (int skip=0, int take=50)
 Busca todas os cursos ativos. Mais...
 
async Task< ActionResult< DetailedReadCourseOutput > > Create ([FromBody] CreateCourseInput request)
 Cria curso. Mais...
 
async Task< ActionResult< DetailedReadCourseOutput > > Update (Guid? id, [FromBody] UpdateCourseInput request)
 Atualiza curso. Mais...
 
async Task< ActionResult< DetailedReadCourseOutput > > Delete (Guid? id)
 Remove curso. Mais...
 

Descrição detalhada

Controller de Curso.

Documentação dos Construtores & Destrutor

◆ CourseController()

WebAPI.Controllers.CourseController.CourseController ( IGetCourseById  getById,
IGetCourses  getAll,
ICreateCourse  create,
IUpdateCourse  update,
IDeleteCourse  delete,
ILogger< CourseController logger 
)
inline

Construtor do Controller de Curso.

Parâmetros
getByIdServiço de obtenção de curso pelo id.
getAllServiço de obtenção de todos os cursos ativos.
createServiço de criação de curso.
updateServiço de atualização de curso.
deleteServiço de remoção de curso.
loggerServiço de log.

Documentação dos métodos

◆ Create()

async Task<ActionResult<DetailedReadCourseOutput> > WebAPI.Controllers.CourseController.Create ( [FromBody] CreateCourseInput  request)
inline

Cria curso.

Retorna
Curso criado

<response code="201">Retorna curso criado</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response>

Grafo de chamadas desta função:

◆ Delete()

async Task<ActionResult<DetailedReadCourseOutput> > WebAPI.Controllers.CourseController.Delete ( Guid?  id)
inline

Remove curso.

Retorna
Curso removido

<response code="200">Retorna curso removido</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response>

◆ GetAll()

async Task<ActionResult<IEnumerable<ResumedReadCourseOutput> > > WebAPI.Controllers.CourseController.GetAll ( int  skip = 0,
int  take = 50 
)
inline

Busca todas os cursos ativos.

Retorna
Todas os cursos ativos

<response code="200">Retorna todas os cursos ativos</response>

◆ GetById()

async Task<ActionResult<DetailedReadCourseOutput> > WebAPI.Controllers.CourseController.GetById ( Guid?  id)
inline

Busca curso pelo id.

Retorna
Curso correspondente

<response code="200">Retorna curso correspondente</response> <response code="400">Requisição incorreta.</response> <response code="404">Curso não encontrado.</response> <response code="401">Usuário não autorizado.</response>

Este é o diagrama das funções que utilizam esta função:

◆ Update()

async Task<ActionResult<DetailedReadCourseOutput> > WebAPI.Controllers.CourseController.Update ( Guid?  id,
[FromBody] UpdateCourseInput  request 
)
inline

Atualiza curso.

Retorna
Curso atualizado

<response code="200">Retorna curso atualizado</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response>


A documentação para esta classe foi gerada a partir do seguinte ficheiro: