Skip to content

Instantly share code, notes, and snippets.

@vedcraft
Created January 2, 2022 23:01
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save vedcraft/cbfe9c6e30202dbc3786a98d4be0ff0e to your computer and use it in GitHub Desktop.
Save vedcraft/cbfe9c6e30202dbc3786a98d4be0ff0e to your computer and use it in GitHub Desktop.
OpenAPI Example
openapi: 3.0.0
info:
description: OpenAPI Specification for the a Hello World API
version: 1.0.0
title: Hello World API
paths:
/:
get:
summary: Provides hello world message
operationId: Sends hello world message
description: Provides a simple Hello World message using GET operation
parameters:
- name: user
in: query
description: Your name.
required: false
schema:
type: string
responses:
"200":
description: Success
servers:
- url: http://api.vedcraft.com
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment