Может ли онлайн-редактор swagger принимать URL-адрес YAML в качестве ввода через адресную строку?

Я хочу получить доступ к https://editor.swagger.io/, но мне нужно, чтобы файл YAML был предварительно загружен на основе в параметре URL.

Поэтому, если я хочу просмотреть https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore.yaml, я должен предоставить это в качестве входных данных для редактора чванства, доступного через Интернет.

Это возможно?


person user9445    schedule 24.10.2018    source источник


Ответы (1)


Да, Swagger Editor поддерживает параметр url:

https://editor.swagger.io/?url=https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml

Обратите внимание, что для загрузки файлов OpenAPI из GitHub/GitLab/Bitbucket/и т. д. вам необходимо указать необработанную ссылку на файл.

Кроме того, чтобы это работало, сервер, на котором размещен файл YAML/JSON, должен использовать HTTPS и поддерживать CORS (т. е. разрешить междоменные вызовы из editor.swagger.io).

person Helen    schedule 24.10.2018
comment
Этот API для editor.swagger.io где-то задокументирован? - person Ben Mares; 01.02.2021
comment
@BenMares Я думаю, что редактор Swagger использует те же параметры конфигурации, что и пользовательский интерфейс Swagger github.com/swagger-api/swagger-ui/blob/master/docs/usage/ - person Helen; 01.02.2021