1
resposta

Documentação Exercitada

Política de Acesso ao Conteúdo

Propósito Documentar informações necessárias sobre controle e acesso ao conteúdo no Blog do Código.

Público-Alvo É importante que todas as pessoas que trabalham no Blog do Código entendam as permissões.

Autenticação

Para acesso a utilização da API, é necessário autenticação

1- Criação de uma conta Rota: POST /usuario Utilização: O usuário preenche as informações de nome, email, senha e cargo.

2- Verificar o email da nova conta Rota: POST /usuario/verifica_email/:token Utilização: O usuário receberá um email com um link de verificação, para confirmar a conta.

3- Realizar Login Rota: POST /usuario/login Utilização: Utiliza-se email e senha para fazer login na conta, e obtém-se um Token de Autenticação na resposta através do cabeçalho, em Authorization; O Token será usado nas demais requisições para a API.

Controle de Conteúdo do Blog

Assinante Permissões: ler todos os posts. Editor Permissões: Cadastrar novos posts no blog e gerenciar seus posts. Admin Permissões: Gerenciamento de usuários e todos os posts do blog

1 resposta

Oi Emily, legal sua documentação, talvez um ponto que possa melhorar seja a formatação em si, colocar o título das sessões em negrito por exemplo e possivelmente descrever com trecho de código JSON os dados que você receberia como válidos e quais casos deveriam dar erro e quais erros seriam esses. São pontos que adicionariam bastante valor a sua documentação.