docs: update README

2026-09-08 20:56:09 +03:00
parent 1835935eaf
commit c74fe817ee
1 changed files with 68 additions and 6 deletions
@@ -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/%D0%9F%D0%BE%D0%B3%D0%BE%D0%B4%D0%B0_%D0%B2_%D0%9E%D1%80%D0%BB%D0%B5%2C_%D0%9E%D1%80%D0%BB%D0%BE%D0%B2%D1%81%D0%BA%D0%B0%D1%8F_%D0%BE%D0%B1%D0%BB%D0%B0%D1%81%D1%82%D1%8C/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")