Структура каталога

Сервисы API обычно используют .proto файлы для определения API и .yaml файлов для настройки службы API. Каждая служба API должна иметь внутри репозитория каталог api, который содержит файлы определений.

Посмотрите пример на GitHub для лучшего понимания.

  • api
    • {service}.yaml - Файл конфигурации, представляющий собой представление YAML google.api.Service proto message.
    • v[0-9]/* - Каждый такой каталог содержит proto-файлы с описанием API.
  • docs/* - Файлы технической документации. Они должны быть в формате Markdown. Каталог содержит стукруту папок для шаблонизатора hugo
  • README.md
  • Makefile
    • init - цель сборки для инициализации библиотек и авторизации в Google Cloud
    • esp - генерация заглушек исходного кода и деплой конфигурации api в Google Cloud
    • dev - старт nginx ESP proxy. Как раз для него важно авторизация, которую делаем через init, а так же наличие ключа test-esp-service-account-creds.json в каталоге ~/.rwmeta