weevely api

? Downloads

• v1.0 Último - download

⚓ Requisitos

• Php 8.0.7
• Mysql 6.x / mariadb 10.x
• Compositor 2.x

Instalação do MacOS:
Você pode instalá -los facilmente via Homebrew:

brew install php mysql composer

Instalação do Windows:

1. Faça o download e instale a versão mais recente do XAMPP. Ele o instalará PHP e MARIADB. Sempre que você quiser usar seu banco de dados, abra o XAMPP e inicie o processo MySQL. Para acessar o PhpMyadmin, inicie os processos Apache e MySQL, clique em Botão Admin ao lado de MySQL
2. Faça o download e instale a versão mais recente do Composer. Um gerente de dependência do PHP.

? Execute API localmente

Você pode hospedar facilmente esta API em seu servidor, se desejar. Mas se você deseja trabalhar apenas com dados usados ​​pelo gelo oficial, poderá pular esta etapa.

Para hospedar a API, basta seguir estas etapas:

1. Verifique os requisitos ☝️
2. Baixe a versão mais recente
3. Abra a pasta no seu terminal e execute composer install
4. Crie seu database
5. Crie o arquivo .env e preencha -o com seus dados de acordo com .env.example arquivo
6. Execute php artisan migrate para preencher o banco de dados com as tabelas necessárias
7. Se você deseja adicionar alguns dados ao banco de dados para teste, execute php artisan db:seed
8. Inicie o servidor API com php artisan serve

? Referência da API

Módulo de autorização

Ação	Solicitar	Método	Requisitos
Registrar	/api/auth/register	POST	Dados
Entrar	/api/auth/signin	POST	Dados
sair	/api/auth/signout	POST	Token do portador
Redefinir senha	/api/auth/reset-password	POST	Dados
Alterar a senha	/api/auth/reset-password/{token}	POST	Dados, token
Remova a solicitação	/api/auth/reset-password/{token}/remove	GET	Token
Atualizar o token	/api/auth/refresh	GET	Token do portador
Obtenha usuário	/api/auth/me	GET	Token do portador

Módulo de usuário

Ação	Solicitar	Método	Requisitos
Atualizar dados	/api/users/me	PATCH	Token do portador, dados
Carregue o avatar	/api/users/me/avatar	POST	Token do portador, dados

Calendários e eventos módulo

Açãon	Solicitar	Método	Requisitos
Pegue meus calendários	/api/calendars/my/{type}	GET	Token do portador, tipo
Crie calendário	/api/calendars/my	POST	Token do portador, dados (opcional)
Obtenha calendário	/api/calendars/{calendar_id}	GET	Token do portador, calendário_id
Atualizar calendário	/api/calendars/{calendar_id}	PATCH	Token do portador, calendário_id, dados
Excluir calendário	/api/calendars/{calendar_id}	DELETE	Token do portador, calendário_id
Compartilhe calendário	/api/calendars/{calendar_id}/share	POST	Token do portador, calendário_id, usuários (string json)
Ocultar calendário	/api/calendars/{calendar_id}/hide	POST	Token do portador, calendário_id
Obtenha eventos	/api/calendars/{calendar_id}/events	GET	Token do portador, calendário_id
Criar evento	/api/calendars/{calendar_id}/events	POST	Token do portador, calendário_id, dados (opcional)
Evento de atualização	/api/calendars/{calendar_id}/events/{event_id}	PATCH	Token do portador, calendário_id, dados
Excluir evento	/api/calendars/{calendar_id}/events/{event_id}	DELETE	Token do portador, calendário_id
Adicione férias	/api/calendars/{calendar_id}/holidays	POST	Token do portador, calendário_id, dados (país, ano)

? Tenha um ótimo dia!

Não se esqueça de conferir Weevely com Next.js
Confira também meus outros projetos e visite meu site!