Skip to content

Swagger для HTTP API

Основная часть всех API — это так называемые CRUD-операции. Наверное, до 40% всех задач будет связано именно с этими операциями.

Сегодня мы реализуем часть данных операций. Следуй алгоритму, описанному ниже, а результаты практики расположи по следующему пути:

/module4/webserver/swagger.

Настройка и генерация Swagger

Добавим Swagger-документацию к нашему серверу. В этой теме будет использоваться библиотека go-swagger, документация и инструкция по установке.

  1. Добавим файл meta.go в папку с нашим сервером:

  1. Запустим go:generate для генерации файла swagger.json:

  1. Продублируем API с сайта Swagger:

Проектирование PetStorage

  1. Для начала в коде создадим PetStorage. Спроектируем интерфейс PetStorager:

  1. Добавим сущность Pet в наш проект. Для этого скопируем ее из документации на сайте Quicktype:

  1. Вставим данный json, как на изображении:

Справа автоматически сгенерируется программный код.

  1. Вставим наш код в проект: