weevely api

? Downloads

• V1.0 Neueste - Download

⚓ Anforderungen

• PHP 8.0.7
• MySQL 6.x / Mariadb 10.x
• Komponist 2.x

MacOS -Installation:
Sie können diese einfach über Homebrew installieren:

brew install php mysql composer

Windows -Installation:

1. Laden Sie die neueste Version von XAMPP herunter und installieren Sie sie. Sie werden sowohl PHP als auch Mariadb installiert. Wann immer Sie Ihre Datenbank verwenden möchten, öffnen Sie den XAMPP und starten Sie den MySQL -Prozess. Um auf PhpMyAdmin zuzugreifen, starten Sie sowohl Apache- als auch MySQL -Prozesse und klicken Sie auf die Schaltfläche Admin neben mySQL
2. Laden Sie die neueste Version von Composer herunter und installieren Sie sie. Ein PHP -Abhängigkeitsmanager.

? Führen Sie die API lokal aus

Sie können diese API einfach auf Ihrem Server hosten, wenn Sie möchten. Wenn Sie jedoch nur mit Daten arbeiten möchten, die von offiziellem weeknig verwendet werden, können Sie diesen Schritt überspringen.

Um die API zu hosten, befolgen Sie die folgenden Schritte:

1. Überprüfen Sie die Anforderungen ☝️
2. Laden Sie die neueste Version herunter
3. Öffnen Sie den Ordner in Ihrem Terminal und führen Sie composer install
4. Erstellen Sie Ihre database
5. Erstellen Sie .env -Datei und füllen Sie sie mit Ihren Daten entsprechend der Datei .env.example -Datei aus
6. Führen Sie php artisan migrate aus, um die Datenbank mit den erforderlichen Tabellen zu füllen
7. Wenn Sie zum Testen einige Daten zur Datenbank hinzufügen möchten, führen Sie php artisan db:seed aus
8. Starten Sie den API -Server mit php artisan serve

? API -Referenz

Autorisierungsmodul

Aktion	Anfrage	Verfahren	Anforderungen
Registrieren	/api/auth/register	POST	Daten
anmelden	/api/auth/signin	POST	Daten
Abmelden	/api/auth/signout	POST	Trägertoken
Passwort zurücksetzen	/api/auth/reset-password	POST	Daten
Kennwort ändern	/api/auth/reset-password/{token}	POST	Daten, Token
Anfrage entfernen	/api/auth/reset-password/{token}/remove	GET	Token
Token erfrischen	/api/auth/refresh	GET	Trägertoken
Benutzer holen	/api/auth/me	GET	Trägertoken

Benutzermodul

Aktion	Anfrage	Verfahren	Anforderungen
Daten aktualisieren	/api/users/me	PATCH	Trägertoken, Daten
Laden Sie Avatar hoch	/api/users/me/avatar	POST	Trägertoken, Daten

Kalender- und Ereignismodul

Actionn	Anfrage	Verfahren	Anforderungen
Holen Sie sich meine Kalender	/api/calendars/my/{type}	GET	Trägertoken, Typ
Kalender erstellen	/api/calendars/my	POST	Trägertoken, Daten (optional)
Kalender bekommen	/api/calendars/{calendar_id}	GET	Trägertoken, Calendar_id
Kalender aktualisieren	/api/calendars/{calendar_id}	PATCH	Trägertoken, Calendar_id, Daten
Kalender löschen	/api/calendars/{calendar_id}	DELETE	Trägertoken, Calendar_id
Kalender teilen	/api/calendars/{calendar_id}/share	POST	Trägertoken, Calendar_id, Benutzer (JSON -String)
Kalender verbergen	/api/calendars/{calendar_id}/hide	POST	Trägertoken, Calendar_id
Ereignisse bekommen	/api/calendars/{calendar_id}/events	GET	Trägertoken, Calendar_id
Ereignis erstellen	/api/calendars/{calendar_id}/events	POST	Trägertoken, Calendar_id, Daten (optional)
Update -Ereignis	/api/calendars/{calendar_id}/events/{event_id}	PATCH	Trägertoken, Calendar_id, Daten
Ereignis löschen	/api/calendars/{calendar_id}/events/{event_id}	DELETE	Trägertoken, Calendar_id
Fügen Sie Feiertage hinzu	/api/calendars/{calendar_id}/holidays	POST	Trägertoken, Calendar_id, Daten (Land, Jahr)

? Ich wünsche ihnen einen wunderbaren Tag!

Vergessen Sie nicht, weevely bei Next.js zu überprüfen
Schauen Sie sich auch meine anderen Projekte an und besuchen Sie meine Website!