From a5940a39a8f5b8f7f1e2e84df90c80ba231b5371 Mon Sep 17 00:00:00 2001 From: Anton Burnashev Date: Tue, 28 May 2024 12:01:34 +0200 Subject: [PATCH] Link rest_api & OpenAPI generator from helpers section in the docs --- docs/website/docs/general-usage/http/overview.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/website/docs/general-usage/http/overview.md b/docs/website/docs/general-usage/http/overview.md index 94dc64eac5..2d193ceb2c 100644 --- a/docs/website/docs/general-usage/http/overview.md +++ b/docs/website/docs/general-usage/http/overview.md @@ -8,6 +8,10 @@ dlt has built-in support for fetching data from APIs: - [RESTClient](./rest-client.md) for interacting with RESTful APIs and paginating the results - [Requests wrapper](./requests.md) for making simple HTTP requests with automatic retries and timeouts +Additionally, dlt provides tools to simplify working with APIs: +- [REST API generic source](../../dlt-ecosystem/verified-sources/rest_api) integrates APIs using a [declarative configuration](../../dlt-ecosystem/verified-sources/rest_api#source-configuration) to minimize custom code. +- [OpenAPI source generator](../../dlt-ecosystem/verified-sources/openapi-generator) automatically creates declarative API configurations from [OpenAPI specifications](https://swagger.io/specification/). + ## Quick example Here's a simple pipeline that reads issues from the [dlt GitHub repository](https://github.com/dlt-hub/dlt/issues). The API endpoint is https://api.github.com/repos/dlt-hub/dlt/issues. The result is "paginated", meaning that the API returns a limited number of issues per page. The `paginate()` method iterates over all pages and yields the results which are then processed by the pipeline.