README.md

SGIF - Sistema de Gerenciamento do IFBA

📚 Rest API Documentation

⚠ AVISO: A documentação da API está em construção.

Versões

Versão 1.0.1

As sessões a seguir estão em ordem alfabética, e os endpoints dentro de cada sessão seguem a seguinte hierarquia de verbos: GET, POST, PUT, DELETE. Os dados presentes em 'parâmetros', 'corpo da requisição' e 'corpo da resposta' são apenas para fins de exemplo e não há garantia que eles estejam salvos na base de dados da API.

Formulário

POST /formularios/formulario

Endpoint para cadastro de formulários.

Parâmetros: N/A.
Corpo da Requisição:

{
    "titulo" : "título do formulário",
    "descricao" : "descrição do formulário",
    "questoes" : [
        {
            "enunciado" : "enunciado 01",
            "respostas" : [
                {
                    "texto" : "conteúdo da resposta 01",
                    "usuario_login" : "login_do_usuario_01"
                },
                {
                    "texto" : "conteúdo da resposta 02",
                    "usuario_login" : "login_do_usuario_02"
                }
            ]
        }
    ]
}

Corpo da Resposta:

{
    "titulo" : "título do formulário",
    "descricao" : "descrição do formulário"
}

PUT /formularios/formulario

Endpoint para a atualização de formulários.

Parâmetros: N/A.
Corpo da Requisição:

{
    "titulo" : "título do formulário",
    "descricao" : "descrição do formulário",
    "questoes" : [
        {
            "enunciado" : "enunciado 01",
            "respostas" : [
                {
                    "texto" : "conteúdo da resposta 01",
                    "usuario_login" : "login_do_usuario_01"
                },
                {
                    "texto" : "conteúdo da resposta 02",
                    "usuario_login" : "login_do_usuario_02"
                }
            ]
        }
    ]
}

Corpo da Resposta:

{
    "titulo" : "título do formulário",
    "descricao" : "descrição do formulário"
}

DELETE /formularios/formulario/{id}

Endpoint para a deletar formulários pelo ID.

Parâmetros:

Nome	Descrição	Obrigatório?
ID	O ID do formulário que será deletado	Sim

Corpo da Requisição: N/A.
Corpo da Resposta:

{
    "titulo" : "título do formulário",
    "descricao" : "descrição do formulário"
}