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

Controller de Professor. Mais...

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

Membros públicos

 ProfessorController (IGetProfessorById getById, IGetProfessors getAll, ICreateProfessor create, IUpdateProfessor update, IDeleteProfessor delete, ILogger< ProfessorController > logger)
 Construtor do Controller de Professor. Mais...
 
async Task< ActionResult< DetailedReadProfessorOutput > > GetById (Guid? id)
 Busca Professor pelo id. Mais...
 
async Task< ActionResult< IEnumerable< ResumedReadProfessorOutput > > > GetAll (int skip=0, int take=50)
 Busca todos os Professor ativos. Mais...
 
async Task< ActionResult< DetailedReadProfessorOutput > > Create ([FromBody] CreateProfessorInput request)
 Cria Professor. Mais...
 
async Task< ActionResult< DetailedReadProfessorOutput > > Update (Guid? id, [FromBody] UpdateProfessorInput request)
 Atualiza Professor. Mais...
 
async Task< ActionResult< DetailedReadProfessorOutput > > Delete (Guid? id)
 Remove Professor. Mais...
 

Descrição detalhada

Controller de Professor.

Documentação dos Construtores & Destrutor

◆ ProfessorController()

WebAPI.Controllers.ProfessorController.ProfessorController ( IGetProfessorById  getById,
IGetProfessors  getAll,
ICreateProfessor  create,
IUpdateProfessor  update,
IDeleteProfessor  delete,
ILogger< ProfessorController logger 
)
inline

Construtor do Controller de Professor.

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

Documentação dos métodos

◆ Create()

async Task<ActionResult<DetailedReadProfessorOutput> > WebAPI.Controllers.ProfessorController.Create ( [FromBody] CreateProfessorInput  request)
inline

Cria Professor.

Retorna
Professor criado

<response code="201">Retorna Professor criado</response> <response code="400">Requisição incorreta.</response>

Grafo de chamadas desta função:

◆ Delete()

async Task<ActionResult<DetailedReadProfessorOutput> > WebAPI.Controllers.ProfessorController.Delete ( Guid?  id)
inline

Remove Professor.

Retorna
Professor removido

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

◆ GetAll()

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

Busca todos os Professor ativos.

Retorna
Todos os Professor ativos

<response code="200">Retorna todos os Professor ativos</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Nenhum Professor encontrado.</response>

◆ GetById()

async Task<ActionResult<DetailedReadProfessorOutput> > WebAPI.Controllers.ProfessorController.GetById ( Guid?  id)
inline

Busca Professor pelo id.

Retorna
Professor correspondente

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

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

◆ Update()

async Task<ActionResult<DetailedReadProfessorOutput> > WebAPI.Controllers.ProfessorController.Update ( Guid?  id,
[FromBody] UpdateProfessorInput  request 
)
inline

Atualiza Professor.

Retorna
Professor atualizado

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


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