Histórico da Página
...
Ao enviar a requisição pode-se informar, como parâmentros (na sub seção parameters
), filtros do status do pedido dentro da sub seção items
.
O Retorno da requisição requisiçã, sub seção produces
, será um JSON contendo a lista filtrada dos pedidos existentes na base de dados junto com o status (responses
) 200 que informa que a operação foi executada com sucesso.
...
No mesmo recurso "pedido", serão enviados os dados envelopados em um código JSON (sub seção consumes
) e o mesmo será retornado na resposta da requisição (sub seção produces
) como comprovação de que os dados foram gravados.
...
Assim como o método POST, também encapsula os dados em um código JSON para atualzar os dados desejados (sub seção consumes
), porém pode também informar essa atualização como parâmetros na URI.
Na procedure progress, como no método GET e POST, também possui a efetivação da ação com os dados de entrada e retorno da requisição em um objeto JSON (sub seção produces
).
Bloco de código | ||
---|---|---|
| ||
/* **SWAGGER** put: tags: - "pedido" summary: "Atualiza um registro existente de pedido" description: "Atualiza os dados de um registro de pedido existente na base de dados utilizando o método Put" operationId: "putPedido" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "Parâmetros necessários enviados no 'payload' para atualizar um pedido existente" required: true schema: $ref: "#/definitions/payloadEnvioPedido" **END SWAGGER** */ PROCEDURE pi-put: DEF INPUT PARAM jsonInput AS JsonObject NO-UNDO. DEF OUTPUT PARAM jsonOutput AS JsonObject NO-UNDO. ASSIGN jsonOutput = jsonInput. END. |
...
A documentação para o método DELETE informa que para executar a exclusão de um registro é preciso passar como parâmetro na URI uma chave na sub seção parameters
.
Como retorno, também apresenta um JSON contendo as informações do registro excluído na sub seção produces
.
Na procedure progress, como nos métodos anteriores, também possui a efetivação da ação com os dados de entrada e retorno da requisição em um objeto JSON.
Bloco de código | ||
---|---|---|
| ||
/* **SWAGGER** delete: tags: - "pedido" summary: "Exclui um pedido existente" description: "Realiza a exlusão de um pedido existente na base de dados utilizando o método PUT" operationId: "deletePedido" produces: - "application/json" parameters: - name: "api_key" in: "header" required: false type: "string" - name: "petIdpedidoId" in: "path" description: "Parâmetros necessários enviados no 'payload' para exlcuir um pedido existente" required: true type: "integer" format: "int64" **END SWAGGER** */ PROCEDURE pi-delete: DEF INPUT PARAM jsonInput AS JsonObject NO-UNDO. DEF OUTPUT PARAM jsonOutput AS JsonObject NO-UNDO. ASSIGN jsonOutput = jsonInput. END. |
...