From 9c9d0352c6dd874df33f4ac22b964531c6d691d2 Mon Sep 17 00:00:00 2001 From: Redume Date: Mon, 24 Feb 2025 20:21:15 +0300 Subject: [PATCH] docs: endpoints list page --- docs/astro.config.mjs | 8 +++++++ .../docs/docs/endpoints/endpoints-list.mdx | 21 +++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 docs/src/content/docs/docs/endpoints/endpoints-list.mdx diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index fb0d309..7e25d5f 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -23,6 +23,14 @@ export default defineConfig({ }, ], }, + { + label: 'Endpoints', + items: [ + { + label: 'Endpoints list', slug: 'docs/endpoints/endpoints-list' + } + ], + }, ], }), ], diff --git a/docs/src/content/docs/docs/endpoints/endpoints-list.mdx b/docs/src/content/docs/docs/endpoints/endpoints-list.mdx new file mode 100644 index 0000000..df0724b --- /dev/null +++ b/docs/src/content/docs/docs/endpoints/endpoints-list.mdx @@ -0,0 +1,21 @@ +--- +title: Endpoints list +--- + +## API Base URL +All requests to our API should be directed to the URL below: + +``` +https://kekkai.redume.su/api/ +``` + + +## API Endpoints +Kekkai has 3 API endpoints: `getRate`, `getChart` and `metadata`. +Below you will find a list of parameters that each endpoint requires and a description of what the API does. + +| Service | API Endpoint | Description | +|--------------|------------------------------------------|---------------------------------------------------------------------------------------------| +| Get Rate | `https://kekkai.redume.su/api/getRate/` | Get currency exchange rate for a specific day or period | +| Create Chart | `https://kekkai.redume.su/api/getChart/` | Creating a chart with exchange rate | +| Metadata | `https://kekkai.redume.su/api/metadata/` | Shows the last and first dates of currency rate collection, as well as available currencies | \ No newline at end of file