Старт приложения
Вот пошаговая инструкция для создания проекта на бойлерплейте Golang:
-
Создай новый репозиторий на GitLab и склонируй его в твой GOPATH/src/gitlab.com/username/your_project, где username — это твой username в gitlab, your_project — название твоего репозитория.
-
Открой проект в IDE, скопируй файлы бойлерплейта в твой новый репозиторий.
-
Сделай глобальную замену всех путей в проекте с ptflp/goboilerplate на username/your_project, где username — это твой username в gitlab.
ctrl/cmd + shift + r, далее replace all.
-
Запусти go mod tidy.
-
Скопируй файл .env.example в .env и настрой переменные окружения для твоего бойлерплейта. Эти переменные могут включать такие вещи, как адрес базы данных, пароли, порты и т. д.
-
Запусти контейнер с помощью docker-compose. Ты можешь использовать команду docker-compose up для запуска контейнера и просмотра вывода приложения.
-
Останови и удали контейнер с API, так как в DB_HOST у нас прописано значение localhost, и он будет пытаться соединиться с локальной базой, а для контейнера он будет по имени контейнера sampledb в представленном случае.
Мы же запустим API локально, с терминала, или в IDE, через наш entrypoint cmd/api/main.go.
- Проверь работу веб-сервера, открыв веб-браузер и перейдя на адрес localhost:ваш_порт/swagger, который мы указали в .env файле (в представленном случае по умолчанию 8080). Если все настроено правильно, ты увидишь веб-страницу Swagger.
- Сгенерируй swagger.json в файле internal/docs/meta.go.
Заметь, в документации есть кнопка Authorize. В данное поле нужно вставлять Bearer (токен_выданный_при_авторизации)/ Тогда методы с замочком станут доступны.
- Наконец, загрузи все файлы бойлерплейта на GitLab.
Вот и все! Теперь у тебя есть готовый проект для разработки веб-API-приложений на Golang.