Inicio>Relacionado con la programación>Pitón
Descargar

Tablón de anuncios

Creación de una API REST de tablero de anuncios mínima viable con fines educativos.

Funcional

  • Obtener listas de todas las etiquetas, publicaciones y usuarios

  • Buscar en listas

  • Registro de usuario

  • Un usuario registrado puede:

    • Agregar nuevas publicaciones

    • Comentar publicaciones existentes

    • Elimina y edita tus publicaciones y comentarios

Requisitos

  • PHP 8.1+

  • laravel 10

  • Compositor

  • mysql

Documentación

Autenticación

POST /api/v1/auth/register Registrarse
Cuerpo
Nombre Tipo tipo de datos Descripción
nombre requerido cadena Nombre
apodo requerido cadena Identificador legible por humanos
correo electrónico requerido cadena Dirección de correo electrónico
contraseña requerido cadena Contraseña
contraseña_confirmada requerido cadena Confirmación de contraseña
Respuesta exitosa
Código HTTP: 201 CREATED 
{
    "access_token",
    "token_type": "Bearer"
}
POST /api/v1/auth/login Iniciar sesión
Cuerpo
Nombre Tipo tipo de datos Descripción
correo electrónico requerido cadena Dirección de correo electrónico
contraseña requerido cadena Contraseña
Respuesta exitosa
Código HTTP: 200 OK 
{
    "access_token",
    "token_type":"Bearer"
}
POST /api/v1/auth/logout Cerrar sesión
Encabezados
Llave Valor
Autorización Portador {token}
Respuesta exitosa
Código HTTP: 204 NO CONTENT

Perfil

GET /api/v1/profile Obtener perfil de usuario autenticado
Encabezados
Llave Valor
Autorización Portador {token}
Respuesta
Código HTTP: 200 OK 
{
    "data": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at",
        "posts_count",
        "comments_count"
    }
}
GET /api/v1/profile/posts Obtener el perfil y las publicaciones de un usuario autenticado
Encabezados
Llave Valor
Autorización Portador {token}
parámetros
Nombre Tipo tipo de datos Descripción
por_página opcional entero Número de publicaciones por página
página opcional entero Número de página
Respuesta
Código 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 Obtenga el perfil y los comentarios de un usuario autenticado
Encabezados
Llave Valor
Autorización Portador {token}
parámetros
Nombre Tipo tipo de datos Descripción
por_página opcional entero Número de comentarios por página
página opcional entero Número de página
Respuesta exitosa
Código 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"
    }
}

Usuarios

GET /api/v1/users Obtener todos los usuarios
parámetros
Nombre Tipo tipo de datos Descripción
q opcional cadena Consulta de búsqueda
por_página opcional entero Número de usuarios por página
página opcional entero Número de página
Respuesta exitosa
Código HTTP: 200 OK 
{
    "data": [
        {
            "user_id",
            "name",
            "nickname",
            "email",
            "created_at",
            "updated_at",
            "posts_count",
            "comments_count"
        },
        ...
    ],
    "links": {...},
    "meta": {...}
}
GET /api/v1/users/{nickname} Obtener usuario
Respuesta exitosa
Código HTTP: 200 OK 
{
    "data": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at",
        "posts_count",
        "comments_count"
    }
}
GET /api/v1/users/{nickname}/posts Obtener el usuario y sus publicaciones
parámetros
Nombre Tipo tipo de datos Descripción
por_página opcional entero Número de publicaciones por página
página opcional entero Número de página
Respuesta exitosa
Código 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 Obtiene el usuario y sus comentarios
parámetros
Nombre Tipo tipo de datos Descripción
por_página opcional entero Número de comentarios por página
página opcional entero Número de página
Respuesta exitosa
Código 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"
    }
}

Etiquetas

GET /api/v1/tags Obtener todas las etiquetas
parámetros
Nombre Tipo tipo de datos Descripción
q opcional cadena Consulta de búsqueda
Respuesta exitosa
Código HTTP: 200 OK 
{
    "data": [
        {
            "tag_id",
            "name",
            "slug",
            "post_count"
        },
        ...
    ]
}
GET /api/v1/tags/{slug} Obtener una etiqueta y sus publicaciones
parámetros
Nombre Tipo tipo de datos Descripción
por_página opcional entero Número de publicaciones por página
página opcional entero Número de página
Respuesta exitosa
Código HTTP: 200 OK 
{
    "data": [
        {
            "post_id",
            "title",
            "price",
            "description",
            "created_at",
            "updated_at",
            "user_id",
            "user_nickname"
        },
    ],
    "links": {...},
    "meta": {...},
    "tag": {
        "tag_id",
        "name",
        "slug"
    }
}

Publicaciones

GET /api/v1/posts Obtener todas las publicaciones
parámetros
Nombre Tipo tipo de datos Descripción
q opcional cadena Consulta de búsqueda
por_página opcional entero Número de publicaciones por página
página opcional entero Número de página
Respuesta exitosa
Código 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} Obtener una publicación y sus comentarios
parámetros
Nombre Tipo tipo de datos Descripción
por_página opcional entero Número de comentarios por página
página opcional entero Número de página
Respuesta exitosa
Código 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 Agregar nueva publicación
Encabezados
Llave Valor
Autorización Portador {token}
Cuerpo
Nombre Tipo tipo de datos Descripción
título opcional cadena Título
precio opcional flotar Precio
descripción opcional cadena Descripción
etiquetas[identificación] opcional matriz[int] Conjunto de ID de etiquetas
Respuesta exitosa
Código 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} Editar publicación
Encabezados
Llave Valor
Autorización Portador {token}
Cuerpo
Nombre Tipo tipo de datos Descripción
título opcional cadena Título
precio opcional flotar Precio
descripción opcional cadena Descripción
etiquetas[identificación] opcional matriz[int] Conjunto de ID de etiquetas
Respuesta exitosa
Código 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} Eliminar una publicación
Encabezados
Llave Valor
Autorización Portador {token}
Respuesta exitosa
Código HTTP: 204 NO CONTENT

Comentarios

POST /api/v1/posts/{id}/comments Agregar un nuevo comentario a una publicación
Encabezados
Llave Valor
Autorización Portador {token}
Cuerpo
Nombre Tipo tipo de datos Descripción
cuerpo requerido cadena Texto del comentario
Respuesta exitosa
Código HTTP: 201 CREATED 
{
    "data": {
        "comment_id",
        "body",
        "created_at",
        "updated_at",
        "post_id",
        "user_id",
        "user_nickname",
    },
}
PUT /api/v1/comments/{id} Editar comentario
Encabezados
Llave Valor
Autorización Portador {token}
Cuerpo
Nombre Tipo tipo de datos Descripción
cuerpo requerido cadena Texto del comentario
Respuesta exitosa
Código HTTP: 200 OK 
{
    "data": {
        "comment_id",
        "body",
        "created_at",
        "updated_at",
        "post_id",
        "user_id",
        "user_nickname",
    }
}
DELETE /api/v1/comments/{id} Eliminar un comentario
Encabezados
Llave Valor
Autorización Portador {token}
Respuesta exitosa
Código HTTP: 204 NO CONTENT

Lanzamiento

  1. Clona este repositorio y ve a la carpeta de tu proyecto:

 clon de git https://github.com/AllaAverina/bulletin-board-APIcd boletín-board-API

  1. Instalar dependencias:

 instalación del compositor

  1. Inicie MySQL, cambie los parámetros para conectarse a la base de datos en el archivo .env.example y ejecute:

 copiar .env.ejemplo .env

  1. Ejecute el comando para ejecutar las migraciones:

 php migración artesanal

O si desea completar la base de datos con datos ficticios:

 php migración artesanal --semilla

  1. Inicie el servidor web:

 servicio artesanal php

  1. Abra en su navegador, por ejemplo, http://localhost:8000/api/v1/posts

Ejecución de pruebas

Cree una nueva base de datos para realizar pruebas, cambie los parámetros para conectarse a ella en el archivo .env.testing y ejecute:

 prueba artesanal de php

Ejecutando en Docker

  1. Clona este repositorio y ve a la carpeta de tu proyecto:

 clon de git https://github.com/AllaAverina/bulletin-board-APIcd boletín-board-API

  1. Instalar dependencias:

 ejecución de la ventana acoplable --rm
     -u "$(id -u):$(id -g)"
     -v "$(contraseña):/var/www/html"
     -w /var/www/html
     laravelsail/php82-composer:último
     instalación del compositor --ignore-platform-reqs

  1. Cree un archivo .env:

 cp.env.docker.examlpe.env

  1. Crea un alias de shell y ejecuta navegar:

 alias vela='[ -f vela ] && sh vela || vendedor de sh/bin/sail'sail up -d

  1. Ejecute el comando para ejecutar las migraciones:

 vela artesanal migrar

O si desea completar la base de datos con datos ficticios:

 vela artesano emigrar --semilla

  1. Ábralo en un navegador, por ejemplo, http://localhost/api/v1/posts

  2. Para detener el uso de contenedores:

 parada de vela

Ejecución de pruebas en Docker

  1. Configure el archivo .env.testing:

 cp .env.docker.pruebas .env.pruebas

  1. Ejecute las pruebas:

 prueba artesanal de vela
Expandir
Información adicional
Aplicaciones relacionadas
Recomendado para ti
Información relacionada Todo