Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention generic ex UI #621

Merged
merged 2 commits into from
May 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions components/extractors/other/generic/generic.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,32 @@ Generic Extractor is quite a special component. As its name suggests, it can **e
- Probably any [REST (Restful) API](https://en.wikipedia.org/wiki/Representational_state_transfer)
- A lot of other APIs

Setting Generic Extractor to retrieve data from an API is a matter of writing the right **JSON configuration**.
Because you have to write it yourself, we made the
[Generic Extractor guide](https://developers.keboola.com/extend/generic-extractor/) a part of our [Developers
## Convenient UI

Recently, we created a convenient user interface that allows you to build a configuration for the Generic Extractor without needing to write JSON code.
Similar to other popular API development tools, you can set up and test the connection in just a few clicks.

Features such as cURL import, request tests, output mapping generator, and dynamic function templates and evaluation make the configuration process easier.

{: .image-popup}
![Generic Extractor - UI Animation](/components/extractors/other/generic/animation.gif)

Because you have to write it yourself, we included the
[Generic Extractor guide](https://developers.keboola.com/extend/generic-extractor/) in our [Developer
Documentation](https://developers.keboola.com/extend/).

No other programming or software engineering skills are necessary. Even though configuring the Generic Extractor may seem quite
complex at first, once you understand the concept, you will be able to extract desired data within (tens of) minutes.
complex at first, once you understand the concept, you can extract desired data within (tens of) minutes.

We strongly recommend configuring your first Generic Extractor using [our
tutorial](https://developers.keboola.com/extend/generic-extractor/tutorial/), which will guide you through the visual builder and underlying JSON configuration.


### JSON Configuration

We strongly recommend you configure your first Generic Extractor using [our
tutorial](https://developers.keboola.com/extend/generic-extractor/tutorial/).
Underneath the UI, the configurations are formed as **JSON**.

To understand what specific parts of an existing configuration do, check the
Even though the UI is intuitive, it is beneficial to understand what specific parts of an existing configuration JSON do. To do so, you may check the
[Configuration Map](https://developers.keboola.com/extend/generic-extractor/map/).

## Template Mode
Expand All @@ -31,11 +45,11 @@ Generic Extractor is used as the base for many data source connectors. These com
{: .image-popup}
![Generic Extractor - template](/components/extractors/other/generic/generic-1.png)

The components can be heavily customized simply by using the **Switch to JSON editor** button.
The components can be heavily customized using the **Switch to JSON editor** button.
If you select the template and want to specify more details using the advanced mode, don’t forget to click **Save** first.
The code will be pre-filled for you based on that template.

{: .image-popup}
![Generic Extractor - template](/components/extractors/other/generic/generic-2.png)

When finished editing, save the configuration. You can also always switch back to the templates, but you'll lose your customizations.
When finished editing, save the configuration. You can always switch back to the templates, but you'll lose your customizations.
Loading