Startseite>Programmierbezogen>Python
Herunterladen

Schwarzes Brett

Erstellen einer minimal brauchbaren Bulletin-Board-REST-API für Bildungszwecke.

Funktional

  • Abrufen von Listen aller Tags, Beiträge und Benutzer

  • Suche in Listen

  • Benutzerregistrierung

  • Ein registrierter Benutzer kann:

    • Neue Beiträge hinzufügen

    • Kommentieren Sie bestehende Beiträge

    • Löschen und bearbeiten Sie Ihre Beiträge und Kommentare

Anforderungen

  • PHP 8.1+

  • Laravel 10

  • Komponist

  • MySQL

Dokumentation

Authentifizierung

POST /api/v1/auth/register Registrieren
Körper
Name Typ Datentyp Beschreibung
Name erforderlich Zeichenfolge Name
Spitzname erforderlich Zeichenfolge Für Menschen lesbarer Bezeichner
E-Mail erforderlich Zeichenfolge E-Mail-Adresse
Passwort erforderlich Zeichenfolge Passwort
passwort_bestätigt erforderlich Zeichenfolge Passwortbestätigung
Erfolgsantwort
HTTP-Code: 201 CREATED 
{
    "access_token",
    "token_type": "Bearer"
}
POST /api/v1/auth/login Anmelden
Körper
Name Typ Datentyp Beschreibung
E-Mail erforderlich Zeichenfolge E-Mail-Adresse
Passwort erforderlich Zeichenfolge Passwort
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "access_token",
    "token_type":"Bearer"
}
POST /api/v1/auth/logout Abmelden
Überschriften
Schlüssel Wert
Genehmigung Inhaber {Token}
Erfolgsantwort
HTTP-Code: 204 NO CONTENT

Profil

GET /api/v1/profile Authentifiziertes Benutzerprofil abrufen
Überschriften
Schlüssel Wert
Genehmigung Inhaber {Token}
Antwort
HTTP-Code: 200 OK 
{
    "data": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at",
        "posts_count",
        "comments_count"
    }
}
GET /api/v1/profile/posts Rufen Sie das Profil und die Beiträge eines authentifizierten Benutzers ab
Überschriften
Schlüssel Wert
Genehmigung Inhaber {Token}
Parameter
Name Typ Datentyp Beschreibung
pro_seite optional int Anzahl der Beiträge pro Seite
Seite optional int Seitenzahl
Antwort
HTTP-Code: 200 OK 
{
    "data": [
        {
            "post_id",
            "title",
            "price",
            "description",
            "created_at",
            "updated_at",
            "user_id",
            "user_nickname",
            "tags": [
                {
                    "tag_id",
                    "name",
                    "slug",
                },
                ...
            ],
            "comments_count"
        }
    ],
    "links": {...},
    "meta": {...},
    "user": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at"
    }
}
GET /api/v1/profile/comments Rufen Sie das Profil und die Kommentare eines authentifizierten Benutzers ab
Überschriften
Schlüssel Wert
Genehmigung Inhaber {Token}
Parameter
Name Typ Datentyp Beschreibung
pro_seite optional int Anzahl der Kommentare pro Seite
Seite optional int Seitenzahl
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "data": [
        {
            "comment_id",
            "body",
            "created_at":,
            "updated_at",
            "post_id",
            "user_id",
            "user_nickname"
        },
        ...
    ],
    "links": {...},
    "meta": {...},
    "user": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at"
    }
}

Benutzer

GET /api/v1/users Alle Benutzer abrufen
Parameter
Name Typ Datentyp Beschreibung
Q optional Zeichenfolge Suchanfrage
pro_seite optional int Anzahl der Benutzer pro Seite
Seite optional int Seitenzahl
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "data": [
        {
            "user_id",
            "name",
            "nickname",
            "email",
            "created_at",
            "updated_at",
            "posts_count",
            "comments_count"
        },
        ...
    ],
    "links": {...},
    "meta": {...}
}
GET /api/v1/users/{nickname} Benutzer abrufen
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "data": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at",
        "posts_count",
        "comments_count"
    }
}
GET /api/v1/users/{nickname}/posts Holen Sie sich den Benutzer und seine Beiträge
Parameter
Name Typ Datentyp Beschreibung
pro_seite optional int Anzahl der Beiträge pro Seite
Seite optional int Seitenzahl
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "data": [
        {
            "post_id",
            "title",
            "price",
            "description",
            "created_at",
            "updated_at",
            "user_id",
            "user_nickname",
            "tags": [
                {
                    "tag_id",
                    "name",
                    "slug"
                },
                ...
            ],
            "comments_count"
        },
        ...
    ],
    "links": {...},
    "meta": {...},
    "user": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at"
    }
}
GET /api/v1/users/{nickname}/comments Holen Sie sich den Benutzer und seine Kommentare
Parameter
Name Typ Datentyp Beschreibung
pro_seite optional int Anzahl der Kommentare pro Seite
Seite optional int Seitenzahl
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "data": [
        {
            "comment_id",
            "body",
            "created_at":,
            "updated_at",
            "post_id",
            "user_id",
            "user_nickname"
        },
        ...
    ],
    "links": {...},
    "meta": {...},
    "user": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at"
    }
}

Schlagworte

GET /api/v1/tags Alle Tags abrufen
Parameter
Name Typ Datentyp Beschreibung
Q optional Zeichenfolge Suchanfrage
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "data": [
        {
            "tag_id",
            "name",
            "slug",
            "post_count"
        },
        ...
    ]
}
GET /api/v1/tags/{slug} Holen Sie sich ein Tag und seine Beiträge
Parameter
Name Typ Datentyp Beschreibung
pro_seite optional int Anzahl der Beiträge pro Seite
Seite optional int Seitenzahl
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "data": [
        {
            "post_id",
            "title",
            "price",
            "description",
            "created_at",
            "updated_at",
            "user_id",
            "user_nickname"
        },
    ],
    "links": {...},
    "meta": {...},
    "tag": {
        "tag_id",
        "name",
        "slug"
    }
}

Beiträge

GET /api/v1/posts Alle Beiträge abrufen
Parameter
Name Typ Datentyp Beschreibung
Q optional Zeichenfolge Suchanfrage
pro_seite optional int Anzahl der Beiträge pro Seite
Seite optional int Seitenzahl
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "data": [
        {
            "post_id,
            "title",
            "price",
            "description",
            "created_at",
            "updated_at",
            "user_id",
            "user_nickname",
            "tags": [
                {
                    "tag_id",
                    "name",
                    "slug"
                },
                ...
            ],
            "comments_count"
        },
        ...
    ],
    "links": {...},
    "meta": {...}
}
GET /api/v1/posts/{id} Einen Beitrag und seine Kommentare abrufen
Parameter
Name Typ Datentyp Beschreibung
pro_seite optional int Anzahl der Kommentare pro Seite
Seite optional int Seitenzahl
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "data": [
        {
            "comment_id",
            "body",
            "created_at",
            "updated_at",
            "post_id",
            "user_id",
            "user_nickname"
        },
        ...
    ],
    "links": {...},
    "meta": {...},
    "post": {
        "post_id",
        "title",
        "price",
        "description",
        "created_at",
        "updated_at",
        "user_id",
        "user_nickname",
        "tags": [
            {
                "tag_id",
                "name",
                "slug"
            },
            ...
        ]
    }
}
POST /api/v1/posts Neuen Beitrag hinzufügen
Überschriften
Schlüssel Wert
Genehmigung Inhaber {Token}
Körper
Name Typ Datentyp Beschreibung
Titel optional Zeichenfolge Titel
Preis optional schweben Preis
Beschreibung optional Zeichenfolge Beschreibung
Tags[id] optional array[int] Array von Tag-IDs
Erfolgsantwort
HTTP-Code: 201 CREATED 
{
    "data": {
        "post_id",
        "title",
        "price",
        "description",
        "created_at",
        "updated_at",
        "user_id",
        "user_nickname",
        "tags": [
            {
                "tag_id",
                "name",
                "slug"
            },
            ...
        ]
    },
}
PUT /api/v1/posts/{id}
Überschriften
Schlüssel Wert
Genehmigung Inhaber {Token}
Körper
Name Typ Datentyp Beschreibung
Titel optional Zeichenfolge Titel
Preis optional schweben Preis
Beschreibung optional Zeichenfolge Beschreibung
Tags[id] optional array[int] Array von Tag-IDs
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "data": {
        "post_id",
        "title",
        "price",
        "description",
        "created_at",
        "updated_at",
        "user_id",
        "user_nickname",
        "tags": [
            {
                "tag_id",
                "name",
                "slug"
            },
            ...
        ]
    },
}
DELETE /api/v1/posts/{id} Einen Beitrag löschen
Überschriften
Schlüssel Wert
Genehmigung Inhaber {Token}
Erfolgsantwort
HTTP-Code: 204 NO CONTENT

Kommentare

POST /api/v1/posts/{id}/comments Einen neuen Kommentar zu einem Beitrag hinzufügen
Überschriften
Schlüssel Wert
Genehmigung Inhaber {Token}
Körper
Name Typ Datentyp Beschreibung
Körper erforderlich Zeichenfolge Kommentartext
Erfolgsantwort
HTTP-Code: 201 CREATED 
{
    "data": {
        "comment_id",
        "body",
        "created_at",
        "updated_at",
        "post_id",
        "user_id",
        "user_nickname",
    },
}
PUT /api/v1/comments/{id} Kommentar bearbeiten
Überschriften
Schlüssel Wert
Genehmigung Inhaber {Token}
Körper
Name Typ Datentyp Beschreibung
Körper erforderlich Zeichenfolge Kommentartext
Erfolgsantwort
HTTP-Code: 200 OK 
{
    "data": {
        "comment_id",
        "body",
        "created_at",
        "updated_at",
        "post_id",
        "user_id",
        "user_nickname",
    }
}
DELETE /api/v1/comments/{id} Einen Kommentar löschen
Überschriften
Schlüssel Wert
Genehmigung Inhaber {Token}
Erfolgsantwort
HTTP-Code: 204 NO CONTENT

Start

  1. Klonen Sie dieses Repository und gehen Sie zu Ihrem Projektordner:

 Git-Klon https://github.com/AllaAverina/bulletin-board-APIcd bulletin-board-API

  1. Abhängigkeiten installieren:

 Composer installieren

  1. Starten Sie MySQL, ändern Sie die Parameter für die Verbindung zur Datenbank in der Datei .env.example und führen Sie Folgendes aus:

 kopieren Sie .env.example .env

  1. Führen Sie den Befehl aus, um die Migrationen auszuführen:

 PHP-Artist migrieren

Oder wenn Sie die Datenbank mit Dummy-Daten füllen möchten:

 php artisan migrate --seed

  1. Starten Sie den Webserver:

 PHP-Handwerker dienen

  1. Öffnen Sie in Ihrem Browser beispielsweise http://localhost:8000/api/v1/posts

Laufende Tests

Erstellen Sie eine neue Datenbank zum Testen, ändern Sie die Parameter für die Verbindung mit ihr in der Datei .env.testing und führen Sie Folgendes aus:

 PHP-Artist-Test

Läuft in Docker

  1. Klonen Sie dieses Repository und gehen Sie zu Ihrem Projektordner:

 Git-Klon https://github.com/AllaAverina/bulletin-board-APIcd bulletin-board-API

  1. Abhängigkeiten installieren:

 Docker run --rm
     -u "$(id -u):$(id -g)"
     -v „$(pwd):/var/www/html“
     -w /var/www/html
     laravelsail/php82-composer:latest
     Composer-Installation --ignore-platform-reqs

  1. Erstellen Sie eine .env-Datei:

 cp.env.docker.examlpe.env

  1. Erstellen Sie einen Shell-Alias ​​und führen Sie „sail“ aus:

 alias Sail='[ -f Segel ] && sh Segel || sh Vendor/bin/sail'sail up -d

  1. Führen Sie den Befehl aus, um die Migrationen auszuführen:

 Segelhandwerker migrieren

Oder wenn Sie die Datenbank mit Dummy-Daten füllen möchten:

 Segelhandwerker migrieren --seed

  1. Öffnen Sie in einem Browser, zum Beispiel http://localhost/api/v1/posts

  2. Um Container zu stoppen, verwenden Sie:

 Segelstopp

Ausführen von Tests in Docker

  1. Richten Sie die Datei .env.testing ein:

 cp .env.docker.testing .env.testing

  1. Führen Sie die Tests aus:

 Segelhandwerkertest
Expandieren
Zusätzliche Informationen
Ähnliche Anwendungen
Empfohlen für Sie
Ähnliche Nachrichten Alle