weevely api

? Téléchargements

• v1.0 Dernier - Télécharger

⚓ Exigences

• PHP 8.0.7
• Mysql 6.x / mariadb 10.x
• Compositeur 2.x

Installation de macOS:
Vous pouvez facilement les installer via Homebrew:

brew install php mysql composer

Installation de Windows:

1. Téléchargez et installez la dernière version de XAMPP. Il vous installera à la fois PHP et MARIADB. Chaque fois que vous souhaitez utiliser votre base de données, ouvrez XAMPP et démarrez le processus MySQL. Pour accéder à PhpMyAdmin, démarrez les processus Apache et MySQL, cliquez sur le bouton Admin à côté de MySQL
2. Téléchargez et installez la dernière version de Composer. Un gestionnaire de dépendances PHP.

? Exécutez l'API localement

Vous pouvez facilement héberger cette API sur votre serveur si vous le souhaitez. Mais si vous voulez seulement travailler avec des données utilisées par Weeevely officiel, vous pouvez ignorer cette étape.

Pour héberger l'API, suivez ces étapes:

1. Vérifiez les exigences ☝️
2. Télécharger la dernière version
3. Ouvrez le dossier dans votre terminal et exécutez composer install
4. Créez votre database
5. Créez un fichier .env et remplissez-le de vos données en conséquence au fichier .env.example
6. Exécutez php artisan migrate pour remplir la base de données avec les tables requises
7. Si vous souhaitez ajouter des données à la base de données pour les tests, exécutez php artisan db:seed
8. Démarrez le serveur API avec php artisan serve

? Référence de l'API

Module d'autorisation

Action	Demande	Méthode	Exigences
Registre	/api/auth/register	POST	Données
Se connecter	/api/auth/signin	POST	Données
se déconnecter	/api/auth/signout	POST	Jeton de support
Réinitialiser le mot de passe	/api/auth/reset-password	POST	Données
Changer le mot de passe	/api/auth/reset-password/{token}	POST	Données, jeton
Supprimer la demande	/api/auth/reset-password/{token}/remove	GET	Jeton
Jeton de rafraîchissement	/api/auth/refresh	GET	Jeton de support
Faire utiliser	/api/auth/me	GET	Jeton de support

Module utilisateur

Action	Demande	Méthode	Exigences
Mettre à jour les données	/api/users/me	PATCH	Jeton de support, données
Télécharger Avatar	/api/users/me/avatar	POST	Jeton de support, données

Calendriers et module d'événements

Actionn	Demande	Méthode	Exigences
Obtenez mes calendriers	/api/calendars/my/{type}	GET	Jeton de support, type
Créer un calendrier	/api/calendars/my	POST	Jeton de support, données (facultatif)
Obtenir le calendrier	/api/calendars/{calendar_id}	GET	Token porteur, calendar_id
Calendrier de mise à jour	/api/calendars/{calendar_id}	PATCH	Token porteur, calendar_id, données
Supprimer le calendrier	/api/calendars/{calendar_id}	DELETE	Token porteur, calendar_id
Calendrier de partage	/api/calendars/{calendar_id}/share	POST	Token de support, calendar_id, utilisateurs (chaîne JSON)
Calendrier de peau	/api/calendars/{calendar_id}/hide	POST	Token porteur, calendar_id
Obtenir des événements	/api/calendars/{calendar_id}/events	GET	Token porteur, calendar_id
Créer un événement	/api/calendars/{calendar_id}/events	POST	Token porteur, calendar_id, données (facultatif)
Mettre à jour l'événement	/api/calendars/{calendar_id}/events/{event_id}	PATCH	Token porteur, calendar_id, données
Supprimer l'événement	/api/calendars/{calendar_id}/events/{event_id}	DELETE	Token porteur, calendar_id
Ajouter des vacances	/api/calendars/{calendar_id}/holidays	POST	Token porteur, calendar_id, données (pays, année)

? Passe une bonne journée!

N'oubliez pas de consulter Weevely avec Next.js
Consultez également mes autres projets et visitez mon site Web!