Beranda>Terkait pemrograman>ular piton
Unduh

Papan buletin

Membuat REST API papan buletin minimum yang layak untuk tujuan pendidikan.

Fungsional

  • Mendapatkan daftar semua tag, postingan, dan pengguna

  • Cari dalam daftar

  • Pendaftaran pengguna

  • Pengguna terdaftar dapat:

    • Tambahkan postingan baru

    • Komentari postingan yang ada

    • Hapus dan edit postingan dan komentar Anda

Persyaratan

  • PHP 8.1+

  • Laravel 10

  • Komposer

  • MySQL

Dokumentasi

Otentikasi

POST /api/v1/auth/register Daftar
Tubuh
Nama Jenis Tipe data Keterangan
nama diperlukan rangkaian Nama
nama panggilan diperlukan rangkaian Pengenal yang dapat dibaca manusia
e-mail diperlukan rangkaian Alamat email
kata sandi diperlukan rangkaian Kata sandi
kata sandi_dikonfirmasi diperlukan rangkaian Konfirmasi kata sandi
Respon Sukses
Kode HTTP: 201 CREATED 
{
    "access_token",
    "token_type": "Bearer"
}
POST /api/v1/auth/login Masuk
Tubuh
Nama Jenis Tipe data Keterangan
e-mail diperlukan rangkaian Alamat email
kata sandi diperlukan rangkaian Kata sandi
Respon Sukses
Kode HTTP: 200 OK 
{
    "access_token",
    "token_type":"Bearer"
}
POST /api/v1/auth/logout Logout
Header
Kunci Nilai
Otorisasi Pembawa {token}
Respon Sukses
Kode HTTP: 204 NO CONTENT

Profil

GET /api/v1/profile Dapatkan profil pengguna yang diautentikasi
Header
Kunci Nilai
Otorisasi Pembawa {token}
Tanggapan
Kode HTTP: 200 OK 
{
    "data": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at",
        "posts_count",
        "comments_count"
    }
}
GET /api/v1/profile/posts Dapatkan profil dan postingan pengguna yang diautentikasi
Header
Kunci Nilai
Otorisasi Pembawa {token}
Param
Nama Jenis Tipe data Keterangan
per_halaman opsional ke dalam Jumlah posting per halaman
halaman opsional ke dalam Nomor halaman
Tanggapan
Kode HTTP: 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 Dapatkan profil dan komentar dari pengguna yang diautentikasi
Header
Kunci Nilai
Otorisasi Pembawa {token}
Param
Nama Jenis Tipe data Keterangan
per_halaman opsional ke dalam Jumlah komentar per halaman
halaman opsional ke dalam Nomor halaman
Respon Sukses
Kode HTTP: 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"
    }
}

Pengguna

GET /api/v1/users Dapatkan semua pengguna
Param
Nama Jenis Tipe data Keterangan
Q opsional rangkaian Permintaan pencarian
per_halaman opsional ke dalam Jumlah pengguna per halaman
halaman opsional ke dalam Nomor halaman
Respon Sukses
Kode HTTP: 200 OK 
{
    "data": [
        {
            "user_id",
            "name",
            "nickname",
            "email",
            "created_at",
            "updated_at",
            "posts_count",
            "comments_count"
        },
        ...
    ],
    "links": {...},
    "meta": {...}
}
GET /api/v1/users/{nickname} Dapatkan pengguna
Respon Sukses
Kode HTTP: 200 OK 
{
    "data": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at",
        "posts_count",
        "comments_count"
    }
}
GET /api/v1/users/{nickname}/posts Dapatkan pengguna dan postingannya
Param
Nama Jenis Tipe data Keterangan
per_halaman opsional ke dalam Jumlah posting per halaman
halaman opsional ke dalam Nomor halaman
Respon Sukses
Kode HTTP: 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 Dapatkan pengguna dan komentarnya
Param
Nama Jenis Tipe data Keterangan
per_halaman opsional ke dalam Jumlah komentar per halaman
halaman opsional ke dalam Nomor halaman
Respon Sukses
Kode HTTP: 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"
    }
}

Tag

GET /api/v1/tags Dapatkan semua tag
Param
Nama Jenis Tipe data Keterangan
Q opsional rangkaian Permintaan pencarian
Respon Sukses
Kode HTTP: 200 OK 
{
    "data": [
        {
            "tag_id",
            "name",
            "slug",
            "post_count"
        },
        ...
    ]
}
GET /api/v1/tags/{slug} Dapatkan tag dan postingannya
Param
Nama Jenis Tipe data Keterangan
per_halaman opsional ke dalam Jumlah posting per halaman
halaman opsional ke dalam Nomor halaman
Respon Sukses
Kode HTTP: 200 OK 
{
    "data": [
        {
            "post_id",
            "title",
            "price",
            "description",
            "created_at",
            "updated_at",
            "user_id",
            "user_nickname"
        },
    ],
    "links": {...},
    "meta": {...},
    "tag": {
        "tag_id",
        "name",
        "slug"
    }
}

Postingan

GET /api/v1/posts Dapatkan semua postingan
Param
Nama Jenis Tipe data Keterangan
Q opsional rangkaian Permintaan pencarian
per_halaman opsional ke dalam Jumlah posting per halaman
halaman opsional ke dalam Nomor halaman
Respon Sukses
Kode HTTP: 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} Dapatkan postingan dan komentarnya
Param
Nama Jenis Tipe data Keterangan
per_halaman opsional ke dalam Jumlah komentar per halaman
halaman opsional ke dalam Nomor halaman
Respon Sukses
Kode HTTP: 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 Tambahkan postingan baru
Header
Kunci Nilai
Otorisasi Pembawa {token}
Tubuh
Nama Jenis Tipe data Keterangan
judul opsional rangkaian Judul
harga opsional mengambang Harga
keterangan opsional rangkaian Keterangan
tag[id] opsional susunan[int] Array ID tag
Respon Sukses
Kode HTTP: 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} Edit postingan
Header
Kunci Nilai
Otorisasi Pembawa {token}
Tubuh
Nama Jenis Tipe data Keterangan
judul opsional rangkaian Judul
harga opsional mengambang Harga
keterangan opsional rangkaian Keterangan
tag[id] opsional susunan[int] Array ID tag
Respon Sukses
Kode HTTP: 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} Menghapus postingan
Header
Kunci Nilai
Otorisasi Pembawa {token}
Respon Sukses
Kode HTTP: 204 NO CONTENT

Komentar

POST /api/v1/posts/{id}/comments Tambahkan komentar baru ke postingan
Header
Kunci Nilai
Otorisasi Pembawa {token}
Tubuh
Nama Jenis Tipe data Keterangan
tubuh diperlukan rangkaian Teks komentar
Respon Sukses
Kode HTTP: 201 CREATED 
{
    "data": {
        "comment_id",
        "body",
        "created_at",
        "updated_at",
        "post_id",
        "user_id",
        "user_nickname",
    },
}
PUT /api/v1/comments/{id} Edit komentar
Header
Kunci Nilai
Otorisasi Pembawa {token}
Tubuh
Nama Jenis Tipe data Keterangan
tubuh diperlukan rangkaian Teks komentar
Respon Sukses
Kode HTTP: 200 OK 
{
    "data": {
        "comment_id",
        "body",
        "created_at",
        "updated_at",
        "post_id",
        "user_id",
        "user_nickname",
    }
}
DELETE /api/v1/comments/{id} Menghapus komentar
Header
Kunci Nilai
Otorisasi Pembawa {token}
Respon Sukses
Kode HTTP: 204 NO CONTENT

Meluncurkan

  1. Kloning repositori ini dan buka folder proyek Anda:

 git clone https://github.com/AllaAverina/bulletin-board-APIcd bulletin-board-API

  1. Instal dependensi:

 instalasi komposer

  1. Mulai MySQL, ubah parameter untuk menghubungkan ke database di file .env.example dan jalankan:

 salin .env.contoh .env

  1. Jalankan perintah untuk menjalankan migrasi:

 migrasi tukang php

Atau jika Anda ingin mengisi database dengan data dummy:

 tukang php bermigrasi --seed

  1. Mulai server web:

 pelayan tukang php

  1. Buka di browser Anda, misalnya http://localhost:8000/api/v1/posts

Menjalankan tes

Buat database baru untuk pengujian, ubah parameter untuk menyambungkannya di file .env.testing dan jalankan:

 tes tukang php

Berjalan di Docker

  1. Kloning repositori ini dan buka folder proyek Anda:

 git clone https://github.com/AllaAverina/bulletin-board-APIcd bulletin-board-API

  1. Instal dependensi:

 menjalankan buruh pelabuhan --rm
     -u "$(id -u):$(id -g)"
     -v "$(pwd):/var/www/html"
     -w /var/www/html
     laravelsail/php82-composer:terbaru
     instalasi komposer --ignore-platform-reqs

  1. Buat file .env:

 cp.env.docker.examlpe.env

  1. Buat alias shell dan jalankan layar:

 alias berlayar='[ -f berlayar ] && sh berlayar || sh vendor/bin/sail'sail up -d

  1. Jalankan perintah untuk menjalankan migrasi:

 tukang layar bermigrasi

Atau jika Anda ingin mengisi database dengan data dummy:

 pengrajin layar bermigrasi --seed

  1. Buka di browser, misalnya http://localhost/api/v1/posts

  2. Untuk menghentikan penggunaan kontainer:

 berhenti berlayar

Menjalankan tes di Docker

  1. Siapkan file .env.testing:

 cp .env.docker.testing .env.testing

  1. Jalankan tes:

 tes tukang layar
Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua