Table: openapi_server - Query OpenAPI Servers using SQL

OpenAPI is a specification for machine-readable interface files for describing, producing, consuming, and visualizing RESTful web services. Previously known as the Swagger Specification, OpenAPI enables the development of APIs that can be understood and used by both machines and humans. The openapi_server resource provides details about the API servers defined in the OpenAPI specification.

Table Usage Guide

The openapi_server table provides insights into API servers defined in the OpenAPI specification. As a developer or API manager, explore server-specific details through this table, including server URLs, descriptions, and variables. Utilize it to uncover comprehensive information about the API servers, such as their location, the environment they're configured for, and any additional metadata.

Examples

Basic info

Explore the basic information of an OpenAPI server, including its base URL, description, and variables. This can be helpful in understanding the server's configuration and identifying any potential issues.

select
  url as base_url,
  description,
  variables,
  path
from
  openapi_server;

select
  url as base_url,
  description,
  variables,
  path
from
  openapi_server;

Get the variables used for substitution in the server's URL

Explore which variables are used to modify the server's URL, allowing you to understand how different servers are set up and configured. This is useful for determining the flexibility and customization of your server URLs.

select
  url as base_url,
  jsonb_pretty(variables) as variables,
  path
from
  openapi_server;

select
  url as base_url,
  variables,
  path
from
  openapi_server;

Schema for openapi_server

Name	Type	Operators	Description
_ctx	jsonb		Steampipe context in JSON form, e.g. connection_name.
description	text		An optional string describing the host designated by the URL.
path	text	=	Path to the file.
url	text		A URL to the target host.
variables	jsonb		A map between a variable name and its value, used for substitution in the server's URL template.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- openapi

You can pass the configuration to the command with the --config argument:

steampipe_export_openapi --config '<your_config>' openapi_server