Skip to content

MoisesGJ/dev-to-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dev-To-API

Integrantes:

  • Emanuel | @MANOLOOG
  • Daniel | @HollowZll
  • Moisés | @MoisesGJ

API URL:

Ejemplos para importar en insomnia (JSON):


Documentación:

Usuarios

Crear un usuario nuevo

  • URL: /users
  • Método: POST
  • Descripción: Crea un nuevo usuario.
  • Datos de Entrada:
    {
      "name": "Nuevo Usuario",
      "email": "nuevo.usuario@example.com"
    }
  • Respuesta Exitosa (201 Created):
    {
      "id": 64ee17e3acd8b24acb385926,
      "name": "Nuevo Usuario",
      "email": "nuevo.usuario@example.com",
      ...
    }

Obtener información de un usuario

  • URL: /users/:id
  • Método: GET
  • Descripción: Obtiene información sobre un usuario específico.
  • Respuesta Exitosa (200 OK):
    {
      "id": 64ee17e3acd8b24acb385926,
      "name": "John Doe",
      "email": "john.doe@example.com",
      ...
    }

Autorización

Obtener autorización

  • URL: /auth/login
  • Método: POST
  • Descripción: Obtiene un token de autorización.
  • Datos de Entrada:
    {
      "email": "nuevo.usuario@example.com",
      "password": "gr3at@3wdsG"
    }
  • Respuesta Exitosa (200 OK):
    {
      ...,
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
    }

Publicaciones

Obtener lista de publicaciones

  • URL: /posts
  • Método: GET
  • Descripción: Obtiene una lista de todas las publicaciones.
  • Respuesta Exitosa (200 OK):
    [
      {
        "id": 1,
        "title": "Mi primera publicación",
        "body": "Este es el contenido de mi primera publicación.",
        "user": 64ee17e3acd8b24acb385926,
        ...
      },
      {
        "id": 2,
        "title": "Otra publicación",
        "body": "Contenido de otra publicación interesante.",
        "user": 64ee17e3acd8b24acb385926,
        ...
      }
    ]

Crear una nueva publicación

  • URL: /posts
  • Método: POST
  • ⚠️ Requiere autorización
  • Descripción: Crea una nueva publicación.
  • Datos de Entrada:
    {
      "title": "Nueva Publicación",
      "body": "Contenido de la nueva publicación.",
      "user": 64ee17e3acd8b24acb385926,
      ...
    }
  • Respuesta Exitosa (201 Created):
    {
      "id": 3,
      "title": "Nueva Publicación",
      "body": "Contenido de la nueva publicación.",
      "user": 64ee17e3acd8b24acb385926,
      ...
    }

Obtener información de una publicación

  • URL: /posts/:id

  • Método: GET

  • Descripción: Obtiene información sobre una publicación específica.

  • Respuesta Exitosa (200 OK):

    {
      "id": 1,
      "title": "Mi primera publicación",
      "body": "Este es el contenido de mi primera publicación.",
      "user": 64ee17e3acd8b24acb385926,
      ...
    }

    Editar información de una publicación

  • URL: /posts/:id

  • Método: PATCH

  • ⚠️ Requiere autorización

  • Descripción: Para permitir actualizar un post

  • Respuesta Exitosa (200 OK):

    {
      "title": "Mi publicación editada",
      ...
    }

    Eliminar información de una publicación

  • URL: /posts/:id

  • Método: DELETE

  • ⚠️ Requiere autorización

  • Descripción: Para permitir borrar un post

  • Respuesta Exitosa (200 OK):

    {
      "title": "Nueva Publicación",
      "body": "Contenido de la nueva publicación.",
      "user": 64ee17e3acd8b24acb385926,
      ...
    }

About

Desarrollo de una API para replicar la funcionalidad de la plataforma Dev.to, permitiendo a los usuarios crear, publicar y gestionar contenido en una comunidad de desarrolladores en línea.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors