Árvore de páginas

Versões comparadas

Chave

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

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

Dessa forma, ao utilizar múltiplos métodos HTTP (como GET, PUT, etc.) em endpoints que compartilham o mesmo caminho com Path Parameters, o nome da variável será considerado conforme a definição do primeiro endpoint declarado. 

Exemplo:

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

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

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

Ou seja, o nome do parâmetro será sempre "used", pois foi definido no primeiro endpoint registrado. O nome "ignored" definido posteriormente não será considerado.