Swagger
Этот сервис очень удобен для проектирования API. Начать им пользоваться очень просто – достаточно перейти по ссылке Try Swagger Editor. По умолчанию предлагают ознакомиться с демо проектом Swagger Petstore. Перед глазами откроется пример отлично спроектированного и документированного API, который тут же можно “потрогать” руками. Проекты сохраняются в формате YAML. При необходимости этот формат можно конвертировать в формат Json...
482 читали · 4 года назад
Настройка Swagger документации для API в Golang
Источник: Nuances of Programming Часть 1, Часть 2, Часть 3 В предыдущей статье мы создали RESTful API в Golang. Теперь, когда у нас есть готовый проект, надо понять, как его использовать. Ведь если нельзя протестировать проект и увидеть его возможности, он будет просто бесполезен. Без полноценной документации, позволяющей тестировать конечные точки и видеть возможности проекта, пользователи не будут даже пытаться его использовать. Стало быть, нужно написать документацию, но на это может уйти много времени, которое можно было бы потратить на разработку крутых функций для наших приложений...