Использование OpenAPI / Swagger CodeGen без swagger.json

Question

У меня есть REST API, который не был создан с учетом Swagger .У него нет файла swagger.json.Я не контролирую этот API.API основан на URL, отвечает на запросы GET, POST и PUT и возвращает JSON или XML.

Есть ли путь вперед, который позволил бы мне использовать инструмент swagger-codegen с этим API?То есть я знаю, что обычно могу сгенерировать клиентский код для API с

$ swagger-codegen generate -i http://petstore.swagger.io/v2/swagger.json -l ruby -o /tmp/test/

. Я хочу знать, есть ли способ

1. написать свой собственный swagger.jsonфайл для API
2. Do - что-то ?- преобразовать запросы и ответы в формат, ожидаемый этим унаследованным API REST

Есть ли в инструментах swagger / OpenAPI что-либо, что позволяет это делать, или это выходит за рамки полномочий проекта?

Answer 1

Боюсь, что будет сложно автоматически сгенерировать документацию, если у вас нет доступа к исходному коду.Как вы сказали в варианте 1, вам лучше всего написать собственную спецификацию OpenAPI для этого API.

Если вы в конечном итоге создадите документ вручную, я настоятельно рекомендую использовать редактор Swagger для написания и проверкидокумент: https://editor.swagger.io/