Created
June 13, 2023 17:47
-
-
Save bipon68/3433773539379e23fb3cdeaa4905102f to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: 3.0.0 | |
info: | |
title: Testing OAS | |
version: 1.0.0 | |
description: > | |
I am learning open API Specification. This is industry standard specification technique for any web service. | |
termsOfService: https://example.com/terms | |
conatct: | |
name: Bipon Biswas | |
url: https://bipon.notes.com | |
email: support@example.com | |
license: | |
name: Aache 2.0 | |
url: https://apache.com | |
servers: | |
- url: https://api.example.com/v1 | |
description: prod server | |
- url: http://localhost:4000/v1 | |
description: dev server | |
paths: | |
/health: | |
get: | |
tags: | |
- Health | |
description: this endpoint test the health of the api | |
responses: | |
'200': | |
description: It will return a success message | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
message: | |
type: string | |
example: ok |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment