OpenAPI / Swagger ವಿವರಣೆ ವೀಕ್ಷಕ ಕುರಿತು — ವಿವರವಾದ ಮಾರ್ಗದರ್ಶಿ
OpenAPI Viewer ಎಂಬುದು RESTful API ಕಾಂಟ್ರಾಕ್ಟ್ಗಳನ್ನು ಪರಿಶೀಲಿಸಲು ಬಳಸುವ ಕ್ಲೈಂಟ್-ಸೈಡ್ ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ರೀಡರ್ ಆಗಿದೆ. ಇದು ಸ್ಥಳೀಯ Swagger UI ಇನ್ಸ್ಟಾಲೇಶನ್ಗಳು ಅಥವಾ ಕ್ಲೌಡ್ ಅವಲಂಬನೆಗಳ ಅಗತ್ಯವಿಲ್ಲದೆ JSON ಅಥವಾ YAML ನಲ್ಲಿರುವ Swagger 2.0 ಮತ್ತು OpenAPI 3.0 / 3.1 ವಿವರಣೆಗಳನ್ನು ರೆಂಡರ್ ಮಾಡುತ್ತದೆ.
ಇದು ಎಲ್ಲಾ ಎಂಡ್ಪಾಯಿಂಟ್ಗಳಿಗಾಗಿ ಸ್ಪಷ್ಟವಾದ ಗುಂಪು ಮಾಡಿದ ಸೈಡ್ಬಾರ್ ನ್ಯಾವಿಗೇಶನ್ ಒದಗಿಸುತ್ತದೆ; ಪಾತ್ಗಳು, HTTP ವಿಧಾನಗಳು (GET, POST, PUT, DELETE), ಹೆಡರ್ ಪ್ಯಾರಾಮೀಟರ್ಗಳು, ಕ್ವೆರಿ ಸ್ಟ್ರಿಂಗ್ಗಳು, ರಚನಾತ್ಮಕ ರಿಕ್ವೆಸ್ಟ್ ಬಾಡಿಗಳು, HTTP ರೆಸ್ಪಾನ್ಸ್ ಕೋಡ್ಗಳು ಮತ್ತು ಡೇಟಾ ಸ್ಕೀಮಾಗಳನ್ನು ಪ್ರದರ್ಶಿಸುತ್ತದೆ.
ಪ್ರಮುಖ ವೈಶಿಷ್ಟ್ಯಗಳು ಮತ್ತು ಸಾಮರ್ಥ್ಯಗಳು
- JSON ಮತ್ತು YAML ನಲ್ಲಿ Swagger 2.0 ಹಾಗೂ OpenAPI 3.0 / 3.1 ವಿವರಣೆಗಳನ್ನು ಬೆಂಬಲಿಸುತ್ತದೆ
- ವರ್ಗೀಕರಿಸಿದ ಎಂಡ್ಪಾಯಿಂಟ್ಗಳು, HTTP ವಿಧಾನಗಳು ಮತ್ತು ಸ್ಥಿತಿ ಕೋಡ್ಗಳನ್ನು ಪಟ್ಟಿ ಮಾಡುವ ಸಂವಾದಾತ್ಮಕ ಸೈಡ್ಬಾರ್
- ನೆಸ್ಟೆಡ್ ಡೇಟಾ ಮಾಡೆಲ್ಗಳು ಮತ್ತು ಪ್ರಾಪರ್ಟಿ ನಿರ್ಬಂಧಗಳನ್ನು ಪ್ರದರ್ಶಿಸುವ ಆಳವಾದ `$ref` ಸ್ಕೀಮಾ ರೆಸಲ್ಯೂಶನ್
- ಮಾಲೀಕತ್ವದ ಎಂಟರ್ಪ್ರೈಸ್ API ಕಾಂಟ್ರಾಕ್ಟ್ಗಳನ್ನು ಸುರಕ್ಷಿತವಾಗಿರಿಸುವ 100% ಕ್ಲೈಂಟ್-ಸೈಡ್ ಆಫ್ಲೈನ್ ಪಾರ್ಸಿಂಗ್
ಬಳಸುವ ವಿಧಾನ
- 1
ನಿಮ್ಮ `swagger.json` ಅಥವಾ `openapi.yaml` ಪಠ್ಯವನ್ನು ಅಂಟಿಸಿ, ಅಥವಾ ಸ್ಪೆಕ್ ಫೈಲ್ ಅನ್ನು ನೇರವಾಗಿ ಅಪ್ಲೋಡ್ ಮಾಡಿ.
- 2
ಸಂವಾದಾತ್ಮಕ ವೀಕ್ಷಕದಲ್ಲಿ ರೆಂಡರ್ ಮಾಡಲಾದ ರಚನಾತ್ಮಕ API ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಅನ್ನು ಬ್ರೌಸ್ ಮಾಡಿ.
- 3
ರಿಕ್ವೆಸ್ಟ್ ಹೆಡರ್ಗಳು, ರಿಕ್ವೆಸ್ಟ್ ಪೇಲೋಡ್ ಸ್ಕೀಮಾಗಳು ಮತ್ತು ರೆಸ್ಪಾನ್ಸ್ ಮಾದರಿಗಳನ್ನು ಪರಿಶೀಲಿಸಲು ಯಾವುದೇ ಎಂಡ್ಪಾಯಿಂಟ್ ಅನ್ನು ವಿಸ್ತರಿಸಿ.
ಸಾಮಾನ್ಯ ಬಳಕೆಯ ಸಂದರ್ಭಗಳು
- → ಮೀಸಲಾದ Swagger UI ಸರ್ವರ್ ಅನ್ನು ಒದಗಿಸದೆ ಬ್ಯಾಕೆಂಡ್ API ವಿವರಣೆಗಳನ್ನು ಆಡಿಟ್ ಮಾಡುವುದು
- → ಅಮಾನ್ಯವಾದ `$ref` ಪಾಯಿಂಟರ್ಗಳಿಗಾಗಿ ಕೈಯಾರೆ ಬರೆದ OpenAPI ವಿವರಣೆಗಳನ್ನು ಪರಿಶೀಲಿಸುವುದು (sanity-check)
- → API ಇಂಟಿಗ್ರೇಶನ್ಗಳ ಸಮಯದಲ್ಲಿ ಫ್ರಂಟ್ಎಂಡ್ ಇಂಜಿನಿಯರ್ಗಳಿಗೆ ನಿಖರವಾದ ಸ್ಕೀಮಾ ಉಲ್ಲೇಖಗಳನ್ನು ಒದಗಿಸುವುದು
ಸಂಬಂಧಿತ ಪರಿಕರಗಳು
HTML ಮೆಟಾ ಟ್ಯಾಗ್ ಜನರೇಟರ್
SEO, Open Graph, Twitter Cards ಮತ್ತು ಮೊಬೈಲ್ ವೀಕ್ಷಣೆಗಾಗಿ ಪ್ರಮಾಣಿತ HTML ಮೆಟಾ ಟ್ಯಾಗ್ಗಳನ್ನು ರಚಿಸಿ.
.gitignore ಜನರೇಟರ್
Node.js, Python, Java, Go, React ಮತ್ತು 100+ ಪ್ಲಾಟ್ಫಾರ್ಮ್ಗಳಿಗಾಗಿ .gitignore ಫೈಲ್ಗಳನ್ನು ತ್ವರಿತವಾಗಿ ರಚಿಸಿ.
ಓಪನ್ ಸೋರ್ಸ್ ಲೈಸೆನ್ಸ್ ಜನರೇಟರ್
MIT, Apache 2.0, GPL v3, BSD ಮತ್ತು Unlicense ನಂತಹ ಜನಪ್ರಿಯ ಓಪನ್ ಸೋರ್ಸ್ ಪರವಾನಗಿಗಳನ್ನು ಕಸ್ಟಮೈಸ್ ಮಾಡಿ ರಚಿಸಿ.
README.md ಜನರೇಟರ್
GitHub ಪ್ರಾಜೆಕ್ಟ್ಗಳಿಗಾಗಿ ಬ್ಯಾಡ್ಜ್ಗಳು, ಇನ್ಸ್ಟಾಲೇಶನ್ ಮಾರ್ಗದರ್ಶಿ ಮತ್ತು ಲೈಸೆನ್ಸ್ ವಿವರಗಳೊಂದಿಗೆ ವೃತ್ತಿಪರ README ರಚಿಸಿ.
Conventional Commits ಜನರೇಟರ್
ಪ್ರಮಾಣಿತ ಮಾದರಿಯಲ್ಲಿ (feat, fix, docs, chore, refactor) Git ಕಮಿಟ್ ಸಂದೇಶಗಳನ್ನು ರಚಿಸಿ.
SemVer ಆವೃತ್ತಿ ಕ್ಯಾಲ್ಕುಲೇಟರ್
ಸೆಮ್ಯಾಂಟಿಕ್ ಆವೃತ್ತಿಯ (SemVer 2.0.0) ಬದಲಾವಣೆಗಳನ್ನು (major, minor, patch) ವಿಶ್ಲೇಷಿಸಿ ಮತ್ತು ಶ್ರೇಣಿಗಳನ್ನು ಹೋಲಿಸಿ.
ಪದೇ ಪದೇ ಕೇಳಲಾಗುವ ಪ್ರಶ್ನೆಗಳು ಮತ್ತು ಗೌಪ್ಯತೆ
ಈ ಪರಿಕರವು YAML ವಿವರಣೆಗಳನ್ನು ನೇರವಾಗಿ ಓದಬಹುದೇ?
ಹೌದು. ಎಂಬೆಡೆಡ್ YAML ಪಾರ್ಸರ್ ಬ್ರೌಸರ್ನಲ್ಲಿಯೇ `.yaml` ಮತ್ತು `.json` OpenAPI ಕಾಂಟ್ರಾಕ್ಟ್ ವಿವರಣೆಗಳನ್ನು ಸಂಪೂರ್ಣವಾಗಿ ಪ್ರಕ್ರಿಯೆಗೊಳಿಸುತ್ತದೆ.
ನನ್ನ ಮಾಲೀಕತ್ವದ API ವಿವರಣೆಯನ್ನು ಬಾಹ್ಯ ಸರ್ವರ್ಗಳಿಗೆ ಅಪ್ಲೋಡ್ ಮಾಡಲಾಗುತ್ತದೆಯೇ?
ಇಲ್ಲ. ಎಲ್ಲಾ ಡಾಕ್ಯುಮೆಂಟ್ ಪಾರ್ಸಿಂಗ್ ಮತ್ತು ಸ್ಕೀಮಾ ರೆಂಡರಿಂಗ್ ಕಟ್ಟುನಿಟ್ಟಾಗಿ ನಿಮ್ಮ ಸ್ಥಳೀಯ ಬ್ರೌಸರ್ ಮೆಮೊರಿಯಲ್ಲಿಯೇ ಕಾರ್ಯಗತಗೊಳ್ಳುತ್ತದೆ.