Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

github.com/mstyushin/go-news-api-gw

Package Overview
Dependencies
Alerts
File Explorer
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

github.com/mstyushin/go-news-api-gw

  • v1.0.1
  • Source
  • Go
  • Socket score

Version published
Created
Source

GoNews API Gateway

Точка входа в бэкенд агрегатора новостей.

Умеет отдавать пагинированный список новостей, конкретную новость по её ID и создавать комментарий под новостью.


Внутренние сервисы:

  • go-news-scraper
  • go-news-comments
  • go-news-moderation

Доступны следующие эндпойнты:

  • GET /news/latest?page={num}&page_size={size}&s={search_string} - отдаёт новости списком, отсортированным по дате создания (дата берётся в том виде, как её вернул тот или иной RSS фид). При этом текст каждой новости сокращён (по-умолчанию до 100 символов, на стороне сервиса go-news-scraper). В каждом объекте статьи из списка имеется заполненное поле link_to_full - ссылка, по которой можно отправить HTTP GET и получить от API Gateway сервиса детальный объект статьи. Поддерживает параметры пагинации page - номер страницы и page_size - число статей в одной странице. Также поддерживает параметр s - строка для поиска по заголовкам статей. Пример ответа:

      {
          "articles":[
              {
                  "id": 1,
                  "title": "some title",
                  "short_content": "something for nothing...",
                  "link_to_full": "http://127.0.0.1:8080/news/1",
                  "pub_time": 1728683086
              },
              {
                  "id": 45,
                  "title": "another title",
                  "short_content": "yet another something...",
                  "link_to_full": "http://127.0.0.1:8080/news/45",
                  "pub_time": 1728684076
              },
          ],
          "paginator": {
                  "num_pages": 8,
                  "cur_page": 1,
                  "page_size": 2
          }
      }
    
  • GET /news/{ID} - отдаёт детальный объект статьи с идентификтором ID + все комментарии к ней (если они есть). Объекты комментариев имеют поле parent_id - если оно равно значению в поле id, то это просто комментарий к новости, в общем случае в parent_id хранится идентификатор комментируемого комментария, т.е. это поле позволяет построить дерево комментариев. Пример ответа:

      {
          "article": {
              "id": 23,
              "title": "some title",
              "content": "something really viral",
              "link": "https://it.slashdot.org/story/24/10/12/1943206/microsofts-take-on-kernel-access-and-safe-deployment-after-crowdstrike-incident",
              "rss_feed_id": 1,
              "pub_time": 1728673086
          },
          "comments": [
              {
                  "id": 1,
                  "article_id": 23,
                  "parent_id": 1,
                  "author": "Alice",
                  "text": "hey there!",
                  "pub_time": 1728693086
              }
          ]
      }
    
  • POST /news/{ID}?c=true - принимает в теле запроса объект комментария к новости с идентификатором ID. Ожидает обязательный query parameter ?c=true, без него ответит 400й ошибкой. В случае, если комментарий прошёл модерацию, то в ответе будет идентификатор созданного комментария с unix timestamp и код ответа 200. В противном случае сервис ответит лишь 400й ошибкой. Пример запроса:

      {
          "author": "Bob",
          "text": "bla bla bla"
      }
    

    Пример ответа:

      {
          "id": 1,
          "pub_time": 1728769897
      }
    

Все эндпойнты поддерживают query parameter request_id - если он присутствует, то запросы к внутренним сервисам будут дополнятся этим же параметром + в заголовки запросов будет добавляться X-Request-Id с данным значением. В случае когда request_id не указан, то он будет сгенерирован и также передан внутренним сервисам. Ответ от сервиса API Gateway всегда будет содержать заголовок X-Request-Id содержащий либо переданный request_id либо сгенерированное значение.

Конфигурационные параметры

ПараметрОписаниеЗначение по-умолчанию
http_portпорт API Gateway сервиса8080
base_urlбазовый URL по которому доступен APIhttp://127.0.0.1:8080
news_scraper_addressIP или имя хоста с сервисом go-news-scraper127.0.0.1
news_scraper_portпорт, на котором слушает go-news-scraper8081
comments_service_addressIP или имя хоста с сервисом go-news-comments127.0.0.1
comments_service_portпорт, на котором слушает go-news-comments8082
moderation_service_addressIP или имя хоста с сервисом go-news-moderation127.0.0.1
moderation_service_portпорт, на котором слушает go-news-moderation8083

Сборка и запуск

Требования

  • golang 1.22
  • docker >=23.0

Просмотр конфигурации по-умолчанию:

$ make build
$ ./bin/go-news-api-gw -print-config

Для быстрого запуска с конфигом по-умолчанию:

$ make run

Сервер будет запущен на 127.0.0.1:8080.

Логи будут писаться сюда:

$ tail -f log/go-news-api-gw.log

Запуск сервера с конфигурацией из файла config.yaml:

$ ./bin/go-news-api-gw -config config.yaml

Остановить сервер:

$ make clean

Показать версию сборки:

$ ./bin/go-news-api-gw -version

Примеры тестовых запросов

$ curl "http://127.0.0.1:8080/news/latest"
$ curl -v -XPOST "http://127.0.0.1:8080/news/1?c=true" -d '{"Author": "Bob", "Text": "bla bla bla"}'
$ curl -v -XPOST "http://127.0.0.1:8080/news/345?c=true" -d '{"Author": "Alice", "Text": "something qwerty"}'
$ curl "http://127.0.0.1:8080/news/latest?page_size=3&page=29"
$ curl "http://127.0.0.1:8080/news/latest?s=TCP&page_size=10&page=1"

Docker

Для удобства все сервисы пакуются в docker-образы и публикуются на Dockerhub автоматически при появлении нового тэга вида v* (напр. v1.1.2) в репозиториях. Имеется компоуз файлик, с которым можно быстро поднять весь стек сервисов локально:

$ cd docker && docker compose up -d

Сервсы будут доступны на:

возможные проблемы
  • при первом запуске Postgres может не успеть проинициализироваться и какие-то сервисы грохнутся. Простой docker compose down && docker compose up -d помогает.
  • что-то не поднимется, если какой-то из используемых контейнерами портов занят: 5432, 8080, 8081, 8082, 8083.
  • контейнер с базой создаёт data-директорию в docker/postgres-data, контейнер не rootless и права на директории будут 999:0, т.е. как минимум удалять её надо будет через sudo rm -rf.
  • понятия не имею будет ли это работать на Windows, теоретически не должно быть проблем.

Тесты

На данный момент есть лишь некоторая заготовка для end-to-end тестов, запускать их следует с поднятыми внутренними сервисами (moderation, comments, scraper).

Для прогона:

$ make e2e-test

FAQs

Package last updated on 13 Oct 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc