Árvore de páginas

Importante!

Em uma API REST, variáveis definidas via Path Parameter compõem a estrutura do endpoint e atuam como chaves identificadoras do recurso.

Quando múltiplos métodos HTTP (como GET, PUT, etc.) utilizam o mesmo caminho base com Path Parameters, o nome da variável é determinado pela primeira rota registrada no servidor.
Nomes diferentes definidos em rotas posteriores para o mesmo caminho serão ignorados.

Exemplo:

#include "tlpp-core.th"
#include "tlpp-rest.th"

@Get("/pathparamsexample/:used")
@Put("/pathparamsexample/:ignored")
function U_samplePathParam()
  local jPath as json
  jPath := oRest:getPathParamsRequest()
return oRest:SetResponse( jPath )

Chamadas:

GET http://127.0.0.1:9080/pathparamsexample/123
PUT http://127.0.0.1:9080/pathparamsexample/123

Resposta (jPath):

{
  "used": "123"
}

Observação:
Nesse cenário, o parâmetro sempre será "used", definido no primeiro endpoint (GET).
O nome "ignored", especificado no PUT, nunca será utilizado pelo mecanismo de resolução de parâmetros.

  • Sem rótulos