Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/turbot/steampipe-plugin-openapi

Use SQL to instantly query resources from OpenAPI. Open source CLI. No DB required.
https://github.com/turbot/steampipe-plugin-openapi

backup etl hacktoberfest openapi postgresql postgresql-fdw sql sqlite steampipe steampipe-plugin zero-etl

Last synced: 3 months ago
JSON representation

Use SQL to instantly query resources from OpenAPI. Open source CLI. No DB required.

Host: GitHub
URL: https://github.com/turbot/steampipe-plugin-openapi
Owner: turbot
License: apache-2.0
Created: 2023-02-24T01:33:19.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-04-12T13:54:54.000Z (10 months ago)
Last Synced: 2024-04-14T10:42:25.354Z (10 months ago)
Topics: backup, etl, hacktoberfest, openapi, postgresql, postgresql-fdw, sql, sqlite, steampipe, steampipe-plugin, zero-etl
Language: Go
Homepage: https://hub.steampipe.io/plugins/turbot/openapi
Size: 366 KB
Stars: 6
Watchers: 11
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

![image](https://hub.steampipe.io/images/plugins/turbot/openapi-social-graphic.png)

# OpenAPI Plugin for Steampipe

Use SQL to query introspection of the OpenAPI definition.

- **[Get started →](https://hub.steampipe.io/plugins/turbot/openapi)**
- Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/turbot/openapi/tables)
- Community: [Join #steampipe on Slack →](https://turbot.com/community/join)
- Get involved: [Issues](https://github.com/turbot/steampipe-plugin-openapi/issues)

## Quick start

### Install

Download and install the latest OpenAPI plugin:

```bash
steampipe plugin install openapi
```

Configure your [config file](https://hub.steampipe.io/plugins/turbot/openapi#configuration) to include directories with OpenAPI definition files.

```hcl
connection "openapi" {
plugin = "openapi"

# Paths is a list of locations to search for OpenAPI definition files
# Paths can be configured with a local directory, a remote Git repository URL, or an S3 bucket URL
# Refer https://hub.steampipe.io/plugins/turbot/openapi#supported-path-formats for more information
# Wildcard based searches are supported, including recursive searches
# Local paths are resolved relative to the current working directory (CWD)

# For example:
# - "*.json" matches all OpenAPI JSON definition files in the CWD
# - "**/*.json" matches all OpenAPI JSON definition files in the CWD and all sub-directories
# - "../*.json" matches all OpenAPI JSON definition files in the CWD's parent directory
# - "*.yml" or "*.yaml" matches all OpenAPI YML or YAML definition files in the CWD
# - "**/*.yml" or "**/*.yaml" matches all OpenAPI YML or YAML definition files in the CWD and all sub-directories
# - "../*.yml" or "../*.yaml" matches all OpenAPI YML or YAML definition files in the CWD's parent directory
# - "steampipe*.json" or "steampipe*.yml" or "steampipe*.yaml" matches all OpenAPI definition files starting with "steampipe" in the CWD
# - "/path/to/dir/*.json" or "/path/to/dir/*.yml" or "/path/to/dir/*.yaml" matches all OpenAPI definition files in a specific directory
# - "/path/to/dir/main.json" or "/path/to/dir/main.yml" or "/path/to/dir/main.yaml" matches a specific file

# If paths includes "*", all files (including non-OpenAPI definition files) in
# the CWD will be matched, which may cause errors if incompatible file types exist

# Defaults to CWD
paths = [ "*.json", "*.yml", "*.yaml" ]
}
```

Run steampipe:

```shell
steampipe query
```

Query all the endpoints available for an API:

```sql
select
api_path,
operation_id,
summary,
deprecated,
tags
from
openapi_path;
```

## Engines

This plugin is available for the following engines:

| Engine | Description
|---------------|------------------------------------------
| [Steampipe](https://steampipe.io/docs) | The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.
| [Postgres FDW](https://steampipe.io/docs/steampipe_postgres/overview) | Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version.
| [SQLite Extension](https://steampipe.io/docs//steampipe_sqlite/overview) | Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it.
| [Export](https://steampipe.io/docs/steampipe_export/overview) | Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database.
| [Turbot Pipes](https://turbot.com/pipes/docs) | Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more.

## Developing

Prerequisites:

- [Steampipe](https://steampipe.io/downloads)
- [Golang](https://golang.org/doc/install)

Clone:

```sh
git clone https://github.com/turbot/steampipe-plugin-openapi.git
cd steampipe-plugin-openapi
```

Build, which automatically installs the new version to your `~/.steampipe/plugins` directory:

```sh
make
```

Configure the plugin:

```shell
cp config/* ~/.steampipe/config
vi ~/.steampipe/config/openapi.spc
```

Try it!

```shell
steampipe query
> .inspect openapi
```