acherkashin / yandex-music-open-api

Swagger документация для Yandex Music.
https://www.cherkashin.dev/yandex-music-open-api/
53 stars 4 forks source link

Перенести модели в отдельные файлы #11

Closed acherkashin closed 3 years ago

acherkashin commented 3 years ago

Большой yaml файл, достаточно сложно поддерживать. К тому же становится невозможно разрабатывать несколько фичей параллельно, создавая несколько пул реквестов, из-за появления постоянных конфликтов.

Документация "Using $ref"

Swagger-editor не поддерживает резолвинг относительных путей - issue.

Пример с решением - данное решение не подходит, так как референцы резолвятся на лету. Необходимо заранее собрать все yaml файлы в один и только после этого запускать swagger-editor.

swagger-cli бандлид пример из ветки issue/6-ref-test без ошибок.

swagger-cli bundle ./src/yandex-music.yaml -o bundled.yaml

Возможно мы могли бы запускать подобный скрипт или библиотеку на каждое изменение и использовать сбандленный файл.

Для решения не должен использоваться никакой серверный фреймворк, так как данный проект в дальнейшем будет хоститься как статический сайт. Если такого решения нет, то можно использовать express и хостить на хероку.

acherkashin commented 3 years ago

Наилучшим способом оказалось написание кастомного webpack loader'а. Инструкцию по написанию лоудера здесь.