Histórico da Página
...
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.
A validação neste método acontece na declaração da procedure progress, na tag 'procedure
', que neste caso é 'pi-post'.
Bloco de código | ||
---|---|---|
| ||
post: procedure: pi-post tags: - "pedido" summary: "Cadastro de um novo pedido" description: "Envia dados de um novo cadastro de pedido para a base de dados utilizando o método POST" operationId: "addPedido" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "Parâmetros necessários enviados no 'payload' para adicionar o novo pedido" required: true schema: $ref: "#/definitions/payloadEnvioPedido" |
...
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.
A validação neste método acontece na declaração da procedure progress, na tag 'procedure
', que neste caso é 'pi-put'.
Bloco de código | ||
---|---|---|
| ||
put: put: procedure: pi-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** */ |
Arquivo *.p:
No arquivo progress a procedure correspondente, assim como no método GET e POST, apresenta a efetivação da ação com os dados de entrada e retorno da requisição em um objeto JSON (sub seção produces
).
...
Como retorno, também apresenta um JSON contendo as informações do registro excluído na sub seção produces
.
A validação neste método acontece na declaração da procedure progress, na tag 'procedure
', que neste caso é 'pi-delete'.
Bloco de código | ||
---|---|---|
| ||
delete: procedure: pi-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: "pedidoIdpetId" in: "path" description: "Parâmetros necessários enviados no 'payload' para exlcuir um pedido existente" required: true type: "integer" format: "int64" |
...