Projects Endpoint

Contains information about the projects that I have created which include the project name, brief description, and a link to the Github repository.

Methods

• GET /projects --> Retrieves all the projects I've done.
• GET /projects/{ projectId } --> Retrieves one specific project.
• POST /projects --> Creates a new project.
• PATCH /projects/{ projectId } --> Updates a specific project by id.
• DELETE /projects/{ projectId } --> Deletes a specific project by id.

Sample API Response

{
    "projects": [
        {
            "id": 1,
            "title": "Navi Web Companion",
            "description": "This project is...",
            "image": "<link_to_image>",
            "link": "https://github.com/..."
        },
        {
            "id": 2,
            "title": "RealTalk Application",
            "description": "This project is...",
            "image": "<link_to_image>",
            "link": "https://github.com/..."
        },
        {
            "id": 3,
            "title": "SmartClaims",
            "description": "This project is...",
            "image": "<link_to_image>",
            "link": "https://github.com/..."
        }
    ]
}

Parameters

Path Parameters

Parameter	Required/Optional	Description	Type
{ projectId }	integer	required	The value for the Project object you want to look up.

Query Parameters

/projects

Parameter	Required/Optional	Description	Type
title	string	optional	The title of the project I work(ed) on.
description	string	optional	The description of the project that I work(ed) on.
image	string	optional	The image of the project website or pictures.
link	string	required	The link to the Github repository of the project.