Skip to content

Instantly share code, notes, and snippets.

@DavidBiesack
Last active February 27, 2023 12:51
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 DavidBiesack/26b04db45565eff3d34d6f1733b36dd1 to your computer and use it in GitHub Desktop.
Save DavidBiesack/26b04db45565eff3d34d6f1733b36dd1 to your computer and use it in GitHub Desktop.
OpenAPI 3.1 document stub (YAML format)
openapi: 3.1.0
info:
title: Your API Title
summary: One sentence description of the API
description: >-
Place a longer description of your API here. Use Markdown for richer text.
Describe the API use cases, who uses it, and for what purpose. Highlight
the significant resources and operations in the API.
You can write multiple paragraphs and link to additional documentation,
such as your domain model.
contact:
name: Your Name or your organization's name
url: http://contact.example.com
email: api@example.com
license:
name: License Name
identifier: SPDX-LICENSE-ID
termsOfService: https://tos.example.com/terms-of-service-1.0.pdf
version: 0.1.0
paths: {}
components:
parameters: {}
requestBodies: {}
schemas: {}
securitySchemes: {}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment