Есть ли способ сгенерировать swagger.json из файла json-server

Для прототипирования мы используем библиотеку json-server, которая создает поддельный REST api на основе нашего файла db.json. Теперь мы хотели бы использовать чванство.

Итак, мой вопрос: есть ли способ сгенерировать swagger.json из нашего файла db.json?

Если нет, знаете ли вы какой-нибудь инструмент для простого создания файла swagger.json?

Спасибо!


javascript openapi swagger json-server
person Marek Sekyra    schedule 13.02.2018    source источник

Ответы (1)


arrow_upward
4
arrow_downward

Если вы можете выполнять вызовы API к своему «поддельному» API, вы можете использовать Swagger Inspector для создания определения API (swagger.json)! Шаги:

  1. Перейдите на https://inspector.swagger.io. Вам следует создать учетную запись, чтобы продолжить следующие шаги.
  2. Звоните в свой фальшивый API.
  3. Выберите вызовы и выберите СОЗДАТЬ ОПРЕДЕЛЕНИЕ API.
  4. Следуйте подсказкам, чтобы назвать API и т. Д.
  5. В конечном итоге вы попадете в текстовый редактор, в котором есть ваш файл swagger.json (вы можете скопировать текст или загрузить файл).

Вуаля!

Не волнуйтесь, вы можете немедленно удалить свой файл API из SwaggerHub, если не хотите, чтобы ваш API был публично открыт (публичный - единственный вариант для бесплатной учетной записи).

person Shannon Wallace    schedule 15.02.2018