feat: openapi.yaml created

This commit is contained in:
skeris 2023-05-20 02:23:01 +03:00
parent 1cde79fc9e
commit 48751d4b1f
7 changed files with 36 additions and 36 deletions

1
.gitignore vendored Normal file

@ -0,0 +1 @@
.idea

8
.idea/.gitignore vendored

@ -1,8 +0,0 @@
# Default ignored files
/shelf/
/workspace.xml
# Editor-based HTTP Client requests
/httpRequests/
# Datasource local storage ignored files
/dataSources/
/dataSources.local.xml

@ -1 +0,0 @@
croupierCbrf

@ -1,9 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="WEB_MODULE" version="4">
<component name="Go" enabled="true" />
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$" />
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>

@ -1,10 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="MarkdownSettings">
<enabledExtensions>
<entry key="MermaidLanguageExtension" value="false" />
<entry key="PlantUMLLanguageExtension" value="false" />
</enabledExtensions>
<option name="hideErrorsInCodeBlocks" value="true" />
</component>
</project>

@ -1,8 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/croupierCbrf.iml" filepath="$PROJECT_DIR$/.idea/croupierCbrf.iml" />
</modules>
</component>
</project>

35
openapi.yaml Normal file

@ -0,0 +1,35 @@
openapi: 3.0.1
info:
title: Сервис получения текущего курса из центробанка РФ
description: |-
Область отвественности сервиса - воркером два раза в день получать текущий курс валют и отдавать его по запросу
version: 1.0.0
tags:
- name: currencies
description: сервис для получения результата пересчёта денег в нужную валюту
paths:
/change
get:
tags:
- currencies
description: Получить количество денег в пересчёте на десятые части указанной валюты. На вход подаются копейки.
parameters:
- name: cur
in: query
description: валюта, в которую надо перевести переданнео число
required: true
- name: val
in: query
description: количество копеек, которые надо перевести в указанную валюту
required: true
responses:
'200':
description: Успешно пересчитана сумма
content:
application/json:
schema:
type: object
properties:
money:
type: integer
example: 12065