# OpenAPI/Swagger Samples

OpenAPI/Swagger specification examples for REST API documentation and contract definition

> Canonical page: https://elysiatools.com/en/samples/openapi

- **Category:** API Documentation

- **Keywords:** openapi, swagger, api, documentation, rest, specification

## Overview

OpenAPI/Swagger specification examples for REST API documentation and contract definition

## Examples

- **Basic OpenAPI 3.0 Pet Store API**: Simple OpenAPI 3.0 specification for a pet store management system
- **User Management API with Authentication**: Complete user management API with authentication, authorization, and role-based access control
- **E-commerce API with Advanced Features**: Complete e-commerce API with products, orders, payments, and inventory management

## When to use

- Use this sample set when you want reference inputs for OpenAPI/Swagger Samples.
- Use it to preview output formats and compare related sample variants.

## How it works

- Open a sample entry to inspect the prepared example payload or asset.
- Compare it with related tools to understand how the workflow connects.

## Use cases

- Basic OpenAPI 3.0 Pet Store API
- User Management API with Authentication
- E-commerce API with Advanced Features

## Frequently asked questions

### What is included in OpenAPI/Swagger Samples?

This page includes curated sample entries, related tools, and neighboring sample collections for OpenAPI/Swagger Samples.

## Related tools

- [OpenAPI to Postman Collection](https://elysiatools.com/en/tools/openapi-to-postman-collection): Turn an OpenAPI 3.x or Swagger 2.0 spec (JSON/YAML) into an importable Postman Collection v2.1.0 with folders, variables, auth and example responses.
- [OpenAPI / Swagger Validator](https://elysiatools.com/en/tools/openapi-validator): Validate OpenAPI 3.0/3.1 and Swagger 2.0 documents structurally: required fields, path/operation completeness, response codes, $ref resolution, operationId uniqueness, and component integrity
- [TOML / INI / HCL / .env / Nix / dotenv ⇄ Kubernetes ConfigMap & Secret Config Format Bridge](https://elysiatools.com/en/tools/toml-ini-hcl-envfile-nix-dotenv-kubernetes-configmap-secret-config-format-bridge): Convert configuration files between dotenv .env, TOML, INI, Java .properties, YAML, JSON, HCL (Terraform/Vagrant native syntax) and Nix attribute sets, and emit Kubernetes ConfigMap or Secret manifests. Template placeholders (${VAR}, {{var}}, envsubst) are preserved verbatim, type inference provenance (string/int/float/bool/list) is tracked, HCL block labels fold into nested keys, and a round-trip diff calls out non-equivalent settings — dropped keys, re-typed values and rewrites — instead of coercing them silently.
- [Config File Semantic Diff](https://elysiatools.com/en/tools/config-file-semantic-diff): Compare JSON, YAML, TOML, and dotenv configurations by key path while ignoring ordering and formatting noise.
- [Environment Config Diff Visualizer](https://elysiatools.com/en/tools/environment-config-diff-visualizer): Compare dev, staging, and production configuration bundles across JSON, YAML, TOML, or ENV formats and highlight drift, missing keys, and cleanup suggestions
- [HCL-YAML Converter](https://elysiatools.com/en/tools/hcl-yaml-converter): Convert between HashiCorp Configuration Language (HCL) and YAML formats for Terraform configurations
- [JSONata Query & Transform Studio](https://elysiatools.com/en/tools/jsonata-query-transform-studio): Preview JSONata-style queries and transformations, compare results across sample payloads, and export the transformed output as JSON, CSV, YAML, or Markdown
- [OpenAPI to TypeScript Generator](https://elysiatools.com/en/tools/openapi-to-typescript-generator): Convert OpenAPI or Swagger JSON/YAML specs into TypeScript API types, request payloads, and response models with configurable output and naming styles

## Related content

- [OpenAPI/Swagger Samples](https://elysiatools.com/en/samples/openapi-swagger): Comprehensive API documentation examples using OpenAPI 3.0 and Swagger specifications for RESTful services
- [Distributed Tracing Samples](https://elysiatools.com/en/samples/distributed-tracing-samples): Comprehensive distributed tracing examples using Jaeger, OpenTelemetry, and other modern observability tools for microservices architecture
- [Grafana Advanced Application Samples](https://elysiatools.com/en/samples/grafana-samples): Comprehensive Grafana samples covering advanced dashboard design, alerting configurations, data source integrations, and plugin development
- [Prometheus Monitoring](https://elysiatools.com/en/samples/prometheus): Comprehensive Prometheus monitoring and alerting system examples including custom metrics exporters, alert rule configuration, PromQL queries, and Grafana dashboard integration
- [CircleCI Configuration Samples](https://elysiatools.com/en/samples/circleci-config): CircleCI configuration examples including workflows, orbs, caching, and advanced deployment strategies
- [Consul Service Mesh Samples](https://elysiatools.com/en/samples/consul): HashiCorp Consul service mesh examples with service discovery, configuration, and security