My README API Model

README.md

{PROJECT_LOGO(300X300)}

ℹ️ Content   |    🚀 Technologies   |    💻 Author   |    📝 License

{DESCRIPTION}

---

ℹ️ Content

• User
  • List All
  • Store
  • Update
  • Delete

---

User

List All Users

ListAll Users.

• URL

  /user

• Method:

  GET

• URL Params

  Required:

  None

  Optional:

• Data Params

  None

• Success Response:

  • Code: 200
    Content:

    [
      {
        "id": 1,
        "name": "Henrique Tavares",
        "email": "ihenrits@gmail.com",
        "avatar_id": null,
        "avatar": null
      }
    ]

---

Store User

Create a single user.

• URL

  /users

• Method:

  POST

• URL Params

  Required:

  None

• Data Params

  {
    "name": "FastFeet",
    "email": "admin@fastfeet.com",
    "password": "123456"
  }

• Success Response:

  • Code: 200
    Content:

    {
      "name": "FastFeet",
      "email": "admin@fastfeet.com",
    }

---

Update User

Update a user.

• URL

  /users

• Method:

  PUT

• URL Params

  Required:

  None

• Data Params

  * Need Authorization - Bearer Token

  {
    "name": "Henrique Tavares",
    "email": "ihenrits@gmail.com",
  }

• Success Response:

  • Code: 200
    Content:

    {
      "id": 1,
      "name": "Henrique Tavares",
      "email": "ihenrits@gmail.com"
    }

---

Delete User

Delete User.

• URL

  /user/:id

• Method:

  DELETE

• URL Params

  Required:

  None

• Data Params

  * Need Authorization - Bearer Token

  None

• Success Response:

  • Code: 200
    Content: No body returned for response

---

🚀 Technologies

• Express

---

💻 Author

Henrique Tavares @tavareshenrique 💻

---

📝 License

This project is licensed under the MIT license - see the archive LICENSE.md for details.