53 lines
1.0 KiB
Plaintext
53 lines
1.0 KiB
Plaintext
📊 Error Summary
|
||
==================================================
|
||
⚠️ WARNING: 1
|
||
❌ ERROR: 1
|
||
ℹ️ INFO: 1
|
||
|
||
📂 Best Practice
|
||
------------------------------
|
||
⚠️ WARNING: Missing API Description
|
||
Category: Best Practice
|
||
Location: info.description
|
||
|
||
Description:
|
||
API description helps users understand the purpose of your API.
|
||
|
||
Suggestions:
|
||
1. Add a description explaining what your API does
|
||
Example:
|
||
"description": "This API provides user management functionality"
|
||
|
||
|
||
|
||
ℹ️ INFO: No Operation Tags
|
||
Category: Best Practice
|
||
Location: paths
|
||
|
||
Description:
|
||
Consider using tags to organize your API operations.
|
||
|
||
Suggestions:
|
||
1. Add tags to operations
|
||
Example:
|
||
"tags": ["users"]
|
||
|
||
|
||
|
||
📂 Validation Error
|
||
------------------------------
|
||
❌ ERROR: Empty Paths Object
|
||
Category: Validation Error
|
||
Location: paths
|
||
|
||
Description:
|
||
OpenAPI document must contain at least one path.
|
||
|
||
Suggestions:
|
||
1. Add at least one API endpoint
|
||
Example:
|
||
"/users": { "get": { "responses": { "200": { "description": "Success" } } } }
|
||
|
||
|
||
|