Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Nota
titleImportante!

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

Dessa forma, ao utilizar Quando múltiplos métodos HTTP (como GET, PUT, etc.) em endpoints que compartilham utilizam o mesmo caminho base com Path Parameters, o nome da variável será considerado conforme a definição do primeiro endpoint declarado. é determinado pela primeira rota registrada no servidor.
Nomes diferentes definidos em rotas posteriores para o mesmo caminho serão ignorados.

Exemplo:

Bloco de código
languagecpp
linenumberstrue
#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:

Bloco de código
GET http://127.0.0.1:9080/pathparamsexample/123
PUT http://127.0.0.1:9080/pathparamsexample/123

Resposta (jPath)Neste caso, ao realizar uma requisição para qualquer um dos métodos (GET ou PUT), o conteúdo de jPath será:

Bloco de código
{
  "used": "123"
}

Ou sejaObservação:
Nesse cenário, o nome do parâmetro sempre será sempre "used", pois foi definido no primeiro endpoint registrado(GET).
O nome "ignored" definido posteriormente não será considerado, especificado no PUT, nunca será utilizado pelo mecanismo de resolução de parâmetros.