Skip to content

Home

Jump to bottom
ivansocket edited this page Mar 15, 2019 · 1 revision

Host: http://localhost:3000

Obter a lista de todos os projetos:

  • Pedido:
    • METHOD: GET
    • URI: /api/project/
  • Resposta:
    • Status-codes: 200
    • Content-type: application/json
    • Example-body: 
      [
    {
"projectName": "Projeto1",
"description": "Este projeto refere-se ao trabalho de daw",
"issues": [{
    "issueId" : "u123",
    "name": "documentação da API",
    "description": "Esta issue será realizada pelo Pero Pinheiro"
    "creationDate": "15-03-2019",
    "closeDate": null,
    "labels": "exploration",
    "state": {
        "avState": "closed",
        "startDate": "15-03-2019"
    }
},{
    "issueId" : "dhh2",
    "name": "Grafismo",
    "description": "Interface gráfica"
    "creationDate": "12-10-2015",
    "closeDate": "12-12-2015",
    "labels": "new-funcionality",
     "state": {
        "avState": "closed",
        "startDate": "12-10-2015"
    }
}]
}
]

Obter o Projeto identificado pelo projectName:

  • Pedido:
    • METHOD: GET
    • URI: /api/project/{projectName}
  • Resposta:
    • Status-codes: 200
    • Content-type: application/json
    • Example-body: 
      {
"projectName": "Projeto1",
"description": "Este projeto refere-se ao trabalho de daw",
"issues": 
[{
    "issueId" : "u123",
    "name": "documentação da API",
    "description": "Esta issue será realizada pelo Pero Pinheiro"
    "creationDate": "15-03-2019",
    "closeDate": null,
    "labels": "exploration",
    "state": {
        "avState": "closed",
        "startDate": "15-03-2019"
    }
},{
    "issueId" : "dhh2",
    "name": "Grafismo",
    "description": "Interface gráfica"
    "creationDate": "12-10-2015",
    "closeDate": "12-12-2015",
    "labels": "new-funcionality",
     "state": {
        "avState": "closed",
        "startDate": "12-10-2015"
    }
}]
}

Criar um Projeto atribuindo-lhe um identificador e descrição:

  • Pedido:

    • METHOD: PUT
    • URI: /api/project/{projectName}
    • Content-type: application/json
    • Example-body: 
      {
"projectName": "Projeto101",
"description": "Projeto antigo",
}

  • Resposta:

    • Status-codes: 201
    • Content-type: text/plain
    • Example-body: Accepted with the Name: "Projeto101"

Editar Projeto, alterando a sua descrição:

  • Pedido:

    • METHOD: PATCH
    • URI: /api/project/{projectName}/description
    • Content-type: application/json
    • Example-body: 
      {
  "description": "Projeto sobre ementas"
  }

  • Resposta:

    • Status-codes: 200
    • Content-type: text/plain
    • Example-body: "A descrição do projeto foi editada com sucesso!"

Apagar um Projeto:

  • Pedido:
    • METHOD: DELETE
    • URI: /api/project/{projectName}
  • Resposta:
    • Status-codes: 200
    • Content-type: text/plain
    • Example-body: ´"O Projeto foi apagado com sucesso"´

Obter a lista de todas as Issues respetivas ao Projeto:

  • Pedido:

    • METHOD: GET
    • URI: /api/project/{projectName}/issue

  • Resposta:

    • Status-codes: 200
    • Content-type: application/json
    • Example-body: 
      "issues": 
[
    {
    "issueId" : "u123",
    "name": "documentação da API",
    "description": "Esta issue será realizada pelo Pero Pinheiro"
    "creationDate": "15-03-2019",
    "closeDate": null,
    "labels": "exploration",
    "state": {
        "avState": "closed",
        "startDate": "15-03-2019"
    }
},{
    "issueId" : "dhh2",
    "name": "Grafismo",
    "description": "Interface gráfica"
    "creationDate": "12-10-2015",
    "closeDate": "12-12-2015",
    "labels": "new-funcionality",
     "state": {
        "avState": "closed",
        "startDate": "12-10-2015"
        }
    }
]

Obter uma Issue de um Projeto:

  • Pedido:

    • METHOD: GET
    • URI: /api/project/{projectName}/issue/{issueID}

  • Resposta:

    • Status-codes: 200
    • Content-type: application/json
    • Example-body: 
      "issues": 
{
    "issueId" : "u123",
    "name": "documentação da API",
    "description": "Esta issue será realizada pelo Pero Pinheiro"
    "creationDate": "15-03-2019",
    "closeDate": null,
    "labels": "exploration",
    "state": 
    {
        "avState": "closed",
        "startDate": "15-03-2019"
    }
}

Colocar uma issue num Projeto:

  • Pedido:

    • METHOD: PUT
    • URI: /api/project/{projectName}/issue/{issueId}

  • Example-body:

    "issues": [
    {
        "issueId" : "u123",
        "name": "documentação da API",
        "description": "Esta issue será realizada pelo Pero Pinheiro"
        "creationDate": "15-03-2019",
        "closeDate": null,
        "labels": "exploration",
        "state": {
            "avState": "closed",
            "startDate": "15-03-2019"
        }
    },
    {
        "issueId" : "dhh2",
        "name": "Grafismo",
        "description": "Interface gráfica"
        "creationDate": "12-10-2015",
        "closeDate": "12-12-2015",
        "labels": "new-funcionality",
        "state": {
            "avState": "closed",
            "startDate": "12-10-2015"
        }
    }
]

  • Resposta:

    • Status-codes: 200
    • Content-type: text/plain
    • Example-body: "Issue adicionada com sucesso ao projeto $projectName"

Editar a descrição da Issue:

  • Pedido:

    • METHOD: PATCH
    • URI: /api/project/{projectName}/issue/{issueId}/description

  • Example-body:

    {
"description": "Esta issue será realizada pelo Pero Pinheiro"
}

  • Resposta:

    • Status-codes: 200
    • Content-type: text/plain
    • Example-body: "Descrição da Issue $issueID atualizada com sucesso"

    GET do state de uma Issue:

  • Pedido:

    • METHOD: GET
    • URI: /api/project/{projectName}/issue/{issueId}/state

  • Resposta:

    • Status-codes: 200

    • Content-type: application/json

    • Example-body:

      ´{
    "avState": "closed",
    "startDate": "12-10-2015"

}´

      Editar o state de uma Issue:

  • Pedido:

    • METHOD: PATCH
    • URI: /api/project/{projectName}/issue/{issueId}/state?avState="archived"

  • Resposta:

    • Status-codes: 200
    • Content-type: text/plain
    • Example-body: "Estado da issue alterado com sucesso"

Clone this wiki locally