Skip to content

Commit 6eb932a

Browse files
authored
docs: Added description for Countries module
1 parent 6f163e8 commit 6eb932a

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

README_RU.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Shadify – это мощный сервис генерации данных и
2626
- [Minesweeper](#minesweeper)
2727
- [Wordsearch](#wordsearch)
2828
- [Anagram](#anagram)
29+
- [Countries](#countries)
2930

3031
### Sudoku
3132

@@ -511,6 +512,65 @@ GET https://shadify.dev/api/anagram/generator
511512

512513
> `Task` - слово из которого необходимо составлять другие слова. <br> `Words` - массив всех возможных слов, которые составляются из `Task`.
513514
515+
### Countries
516+
517+
Модуль Countries позволяет генерировать викторины, такие как "угадай столицу" или "угадай страну по изображению флага". Это простой и полезный модуль для создания приложений для проверки и тренировки знаний по всем странам мира.
518+
519+
- Генерация задания "угадай столицу"
520+
521+
```rust
522+
GET https://shadify.dev/api/countries/capital-quiz
523+
```
524+
525+
| Параметр | Описание |
526+
| ----------- | -------------------------------------------------------------------------------------------------------------------------------- |
527+
| `variants` | _Опциональный_ <br> Число от 2 до 6, соответствует количеству различных вариантов, из которых вы должны выбрать правильную столицу заданной страны. <br> Значение по умолчанию – 4. |
528+
529+
Возвращаемый ответ:
530+
531+
```json
532+
{
533+
"country": "Cyprus",
534+
"flag": "https://flagcdn.com/w320/cy.png",
535+
"variants": [
536+
"Nicosia",
537+
"Juba",
538+
"Oslo",
539+
"Jamestown"
540+
],
541+
"answer": "Nicosia"
542+
}
543+
```
544+
545+
> `country` - страна для которой вы должны угадать столицу. <br> `flag` - изображение флага страны (взято из [Flagpedia API](https://flagpedia.net/download/api), можно кастомизировать). <br> `variants` - массив возможных вариантов ответа. <br> `answer` - правильный ответ.
546+
547+
- Генерация задания "угадай страну по изображению флага"
548+
549+
```rust
550+
GET https://shadify.dev/api/countries/country-quiz
551+
```
552+
553+
| Параметр | Описание |
554+
| ----------- | -------------------------------------------------------------------------------------------------------------------------------- |
555+
| `variants` | _Опциональный_ <br> Число от 2 до 6, соответствует количеству различных вариантов, из которых вы должны выбрать правильную страну по заданному изображению флага. <br> Значение по умолчанию – 4. |
556+
557+
Возвращаемый ответ:
558+
559+
```json
560+
{
561+
"flag": "https://flagcdn.com/w320/dk.png",
562+
"variants": [
563+
"Yemen",
564+
"Denmark",
565+
"Norfolk Island",
566+
"Vietnam"
567+
],
568+
"answer": "Denmark"
569+
}
570+
```
571+
572+
> `flag` - изображение флага страны, которую вы должны угадать. <br> `variants` - массив возможных вариантов ответа. <br> `answer` - правильный ответ.
573+
514574
## Запуск локального сервера
515575

516576
1. Склонируйте этот репозиторий к себе на компьютер:

0 commit comments

Comments
 (0)