Tinkoff / invest-openapi-java-sdk

Apache License 2.0
167 stars 46 forks source link

Каракули в документации и в swagger #111

Closed skarpushin closed 3 years ago

skarpushin commented 4 years ago

При открытии свагера все комментарии каракулями image

Тоже самое при переходе на исходники в IDE image

AlexanderVolkovTCS commented 3 years ago

В интерфейсе сваггера , в notepad++ и при загрузке в visual code проблем нет: https://tinkoffcreditsystems.github.io/invest-openapi/swagger-ui/

В вашем IDE можно изменить кодировку вручную?

skarpushin commented 3 years ago

Браузер = Chrome -- в нём я не нашёл как поменять кодировку. Да и как-то прошлый век это уже. Предполагается, что через HTTP Header "Content-Type" сервер сразу сообщает корректную кодировку клиенту. Сейчас там content-type: text/yaml а должно быть content-type: text/yaml; charset=utf-8

IDE = Eclipse. Не знаю, где там это настроить, За уже 12 лет работы на Java, ещё ни разу не встрчал комментарии на русском :-) Да и главное -- хотелось бы, чтобы работало из коробк.

zlumyo commented 3 years ago

Провёл эксперимент. Открыл файл в браузере https://tinkoffcreditsystems.github.io/invest-openapi/swagger-ui/swagger.yaml Сохранил (Ctrl+S). Открыл в редакторе (например VScode). Редактор говорит, что файл в кодировке UTF-8. Каракуль нет. Никаких дополнительных действий не производил. Соглсен, что charset=utf-8 стоит поставить, но это уже вопрос не к SDK, а к документации API.

zlumyo commented 3 years ago

Ещё раз всё проверил. Оригинал файла в репозитории хранится в UTF-8. Мы хостимся в GithubPages. Он ожидает, что файлы будут в UTF-8, а потому не производит никаких манипуляций - отдаёт всё как есть. Посему механизмов модифицировать хедеры не предоставляется. Судя по скриншотам, мы имеем дело с Windows. Увы, такие проблемы там могут возникать. С нашей стороны мы вряд ли что-то можем сделать.