precificacao/swagger.yaml at master · junioweb/precificacao · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
swagger: "2.0"
info:
  title: "Precificação"
  description: "Essa API auxiliará na formação de preços dos mais variados produtos. Com cálculos de custo, de preço de venda e de margem de lucro."
  version: "1.0.0"
  contact:
    name: "Fernando Júnior"
    email: "fernando.junior@thorgus.com"
  license:
    name: "Licença BSD"
    url: "https://opensource.org/licenses/BSD-3-Clause"
host: "api.thorgus.com"
basePath: "/precos/v1"
schemes:
- "https"
tags:
- name: "venda"
  description: "Preço de Venda do produto."
  externalDocs:
    description: "Veja mais detalhes sobre os cálculos."
    url: "https://github.com/junioweb/precificacao"
- name: "lucro"
  description: "Margem de Lucro sobre o Custo Total Unitário."
  externalDocs:
    description: "Veja mais detalhes sobre os cálculos."
    url: "https://github.com/junioweb/precificacao"
- name: "custo"
  description: "Custo Total Unitário do produto."
  externalDocs:
    description: "Veja mais detalhes sobre os cálculos."
    url: "https://github.com/junioweb/precificacao"
- name: "encargos"
  description: "Encargos sobre o Preço de Venda do produto."
  externalDocs:
    description: "Veja mais detalhes sobre os cálculos."
    url: "https://github.com/junioweb/precificacao"
paths:
  /venda:
    get:
      tags:
      - "venda"
      summary: "Calcule o Preço de Venda do produto"
      description: "Aqui é retornado o preço de venda do produto, de acordo com os dados passados no parâmetro. \nFórmula:\nP = C(1+M)/(1-E) \nLegenda:\nP - Preço de Venda\nC - Custo Total Unitário\nM - Margem de Lucro\nE - Encargos"
      produces:
      - "application/xml"
      - "application/json"
      parameters:
      - name: "custo"
        in: "query"
        description: "Custo Total Unitário. Resultado da soma entre Custo Direto e Indireto."
        required: true
        type: "number"
        format: "float"
      - name: "encargos"
        in: "query"
        description: "Porcentagem sobre o Preço de Venda. \n(Ex.: 26% => 0.26 //Deve ser inserido em formato decimal)"
        required: true
        type: "number"
        format: "float"
      - name: "lucro"
        in: "query"
        description: "Margem de Lucro aplicada sobre o Custo Total Unitário. \n(Ex.: 28.7% => 0.287 //Deve ser inserido em formato decimal)"
        required: true
        type: "number"
        format: "float"
      responses:
        200:
          description: "Cálculo realizado com sucesso."
          schema:
            $ref: "#/definitions/Venda"
        400:
          description: "Erro na Requisição (Parâmetros inválidos)."
  /lucro:
    get:
      tags:
      - "lucro"
      summary: "Calcule a Margem de Lucro aplicada sobre o Custo Total Unitário."
      description: "Aqui é retornada a margem de lucro aplicada sobre o Custo Total Unitário, de acordo com os dados passados no parâmetro. \nFórmula:\nM = P(1-E)-C \nLegenda:\nP - Preço de Venda\nC - Custo Total Unitário\nM - Margem de Lucro\nE - Encargos"
      produces:
      - "application/xml"
      - "application/json"
      parameters:
      - name: "venda"
        in: "query"
        description: "Preço de Venda do produto."
        required: true
        type: "number"
        format: "float"
      - name: "custo"
        in: "query"
        description: "Custo Total Unitário. Resultado da soma entre Custo Direto e Indireto."
        required: true
        type: "number"
        format: "float"
      - name: "encargos"
        in: "query"
        description: "Porcentagem sobre o Preço de Venda. \n(Ex.: 26% => 0.26 //Deve ser inserido em formato decimal)"
        required: true
        type: "number"
        format: "float"
      responses:
        200:
          description: "Cálculo realizado com sucesso."
          schema:
            $ref: "#/definitions/Lucro"
        400:
          description: "Erro na Requisição (Parâmetros inválidos)."
  /custo:
    get:
      tags:
      - "custo"
      summary: "Calcule o Custo Total Unitário do produto."
      description: "Aqui é retornado o Custo Total Unitário do Produto, de acordo com os dados passados no parâmetro. \nFórmula:\nC = P(1-E)/(1+M) \nLegenda:\nP - Preço de Venda\nC - Custo Total Unitário\nM - Margem de Lucro\nE - Encargos"
      produces:
      - "application/xml"
      - "application/json"
      parameters:
      - name: "venda"
        in: "query"
        description: "Preço de Venda do produto."
        required: true
        type: "number"
        format: "float"
      - name: "encargos"
        in: "query"
        description: "Porcentagem sobre o Preço de Venda. \n(Ex.: 26% => 0.26 //Deve ser inserido em formato decimal)"
        required: true
        type: "number"
        format: "float"
      - name: "lucro"
        in: "query"
        description: "Margem de Lucro aplicada sobre o Custo Total Unitário. \n(Ex.: 28.7% => 0.287 //Deve ser inserido em formato decimal)"
        required: true
        type: "number"
        format: "float"
      responses:
        200:
          description: "Cálculo realizado com sucesso."
          schema:
            $ref: "#/definitions/Custo"
        400:
          description: "Erro na Requisição (Parâmetros inválidos)."
  /encargos:
    get:
      tags:
      - "encargos"
      summary: "Calcule os Encargos sobre o Preço de Venda do produto."
      description: "Aqui é retornado os Encargos sobre o Preço de Venda do Produto, de acordo com os dados passados no parâmetro. \nFórmula:\nE = C(1+M)-P \nLegenda:\nP - Preço de Venda\nC - Custo Total Unitário\nM - Margem de Lucro\nE - Encargos"
      produces:
      - "application/xml"
      - "application/json"
      parameters:
      - name: "venda"
        in: "query"
        description: "Preço de Venda do produto."
        required: true
        type: "number"
        format: "float"
      - name: "custo"
        in: "query"
        description: "Custo Total Unitário. Resultado da soma entre Custo Direto e Indireto."
        required: true
        type: "number"
        format: "float"
      - name: "lucro"
        in: "query"
        description: "Margem de Lucro aplicada sobre o Custo Total Unitário. \n(Ex.: 28.7% => 0.287 //Deve ser inserido em formato decimal)"
        required: true
        type: "number"
        format: "float"
      responses:
        200:
          description: "Cálculo realizado com sucesso."
          schema:
            $ref: "#/definitions/Encargos"
        400:
          description: "Erro na Requisição (Parâmetros inválidos)."
definitions:
  Venda:
    type: "object"
    properties:
      valor:
        type: "number"
        format: "float"
    xml:
      name: "Venda"
  Lucro:
    type: "object"
    properties:
      valor:
        type: "number"
        format: "float"
      porcentagem:
        type: "number"
        format: "float"
    xml:
      name: "Lucro"
  Custo:
    type: "object"
    properties:
      valor:
        type: "number"
        format: "float"
      porcentagem:
        type: "number"
        format: "float"
    xml:
      name: "Custo"
  Encargos:
    type: "object"
    properties:
      valor:
        type: "number"
        format: "float"
      porcentagem:
        type: "number"
        format: "float"
    xml:
      name: "Encargos"
externalDocs:
  description: "Veja mais detalhes sobre os cálculos"
  url: "https://github.com/junioweb/precificacao"