docs: update README

This commit is contained in:
2026-09-08 21:07:57 +03:00
parent 1835935eaf
commit a6f6586969
+68 -6
View File
@@ -1,13 +1,75 @@
# API Gallery
Weather and TV program API
Currently implemented APIs:
![API Gallery](docs/screenshot.png "API Gallery")
- Weather forecast
- TV program
## View
## API
Swagger: https://api.shmyga.ru/docs
### Weather
#### Providers list
```
https://api.shmyga.ru/api/weather/providers
```
#### Locations search
```
https://api.shmyga.ru/api/weather/{provider}/locations?query={query}
```
#### Weather forecast
```
https://api.shmyga.ru/api/weather/{provider}/{location_id}/day/{date}
https://api.shmyga.ru/api/weather/{provider}/{location_id}/days/{days_count}
```
### TV program
#### Providers list
```
https://api.shmyga.ru/api/schedule/providers
```
#### Channels search
```
https://api.shmyga.ru/api/schedule/{provider}/channels?query={query}
```
#### TV program
```
https://api.shmyga.ru/api/schedule/{provider}/{channel_id}/{date}
```
## Providers
### Weather
| Provider | Site | API sample |
| :- | :- | :- |
| gismeteo | https://www.gismeteo.ru | https://api.shmyga.ru/api/weather/gismeteo/orel-4432/day/today |
| openweather | https://openweathermap.org | https://api.shmyga.ru/api/weather/openweather/52.9685433%3A36.0692477/day/today |
| yandex | https://yandex.ru/pogoda | https://api.shmyga.ru/api/weather/yandex/10/day/today |
| rp5 | https://rp5.ru | https://api.shmyga.ru/api/weather/rp5/Погода_в_Орле%2C_Орловская_область/day/today |
### TV program
| Provider | Site | API sample |
| :- | :- | :- |
| matchtv | https://matchtv.ru/tvguide | https://api.shmyga.ru/api/schedule/matchtv/igra/today |
| yandextv | https://tv.yandex.ru | https://api.shmyga.ru/api/schedule/yandextv/146/today |
## Demo
https://api.shmyga.ru
## Swagger
https://api.shmyga.ru/docs
![API Gallery](docs/screenshot.png "API Gallery")