docs: Add example YAML files
- examples/custom.yaml: Custom YAML format example - examples/postman.yaml: Postman Collection v2.1 example - examples/openapi.yaml: OpenAPI 3.0 example
This commit is contained in:
1 parent
bf47218831
commit
2250961d09
3 files changed
+150
No files matched your search
@@ -0,0 +1,50 @@
|
||||
openapi: "3.0.0"
|
||||
info:
|
||||
title: "Test API"
|
||||
version: "1.0.0"
|
||||
|
||||
servers:
|
||||
- url: http://localhost:8080
|
||||
|
||||
paths:
|
||||
/api/login:
|
||||
post:
|
||||
operationId: "loginUser"
|
||||
summary: "Login user"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
password:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: "Success"
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
token:
|
||||
type: string
|
||||
|
||||
/api/profile:
|
||||
get:
|
||||
operationId: "getProfile"
|
||||
summary: "Get user profile"
|
||||
responses:
|
||||
"200":
|
||||
description: "Success"
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
email:
|
||||
type: string
|
||||
Reference in new issue
Block a user