Skip to content

docs: add Xquik remote spec example #3

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.

Sign up for GitHub

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

Closed
kriptoburak wants to merge 1 commit into from
Closed

docs: add Xquik remote spec example #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,36 @@ Both `apifable.config.json` and `.apifable/auth.json` support `${ENV_VAR}` synta
}
```

#### Remote API Example: Xquik

Xquik publishes an OpenAPI 3.1 spec for X/Twitter automation at
`https://xquik.com/openapi.json`. Configure it as a remote spec and keep the API
key in `.apifable/auth.json`.

`apifable.config.json`:

```json
{
"spec": {
"path": "openapi/xquik.json",
"url": "https://xquik.com/openapi.json"
}
}
```

`.apifable/auth.json`:

```json
{
"headers": {
"x-api-key": "${XQUIK_API_KEY}"
}
}
```

Then refresh the local spec and ask apifable to inspect tags such as `Tweets`,
`Trends`, or `Users`.

#### Headers Priority (highest to lowest)

1. `.apifable/auth.json` headers (overrides same-named keys)
Expand Down