OpenAPI / Swagger பார்வையாளர் பற்றி — விரிவான வழிகாட்டி
OpenAPI Viewer என்பது RESTful API ஒப்பந்தங்களை ஆராய்வதற்கான கிளையன்ட்-சைட் ஆவண ரீடர் ஆகும். இது உள்ளூர் Swagger UI நிறுவல்கள் அல்லது கிளவுட் சார்புகள் எதுவும் தேவையின்றி JSON அல்லது YAML வடிவங்களில் உள்ள Swagger 2.0 மற்றும் OpenAPI 3.0 / 3.1 விவரக்குறிப்புகளை ரெண்டர் செய்கிறது.
இது அனைத்து எண்ட்பாயிண்ட்களுக்கும் நேர்த்தியாக தொகுக்கப்பட்ட பக்கப்பட்டி வழிசெலுத்தலை வழங்குகிறது; இதன் மூலம் பாதைகள் (paths), HTTP முறைகள் (GET, POST, PUT, DELETE), ஹெடர் அளவுருக்கள், வினவல் சரங்கள் (query strings), கட்டமைக்கப்பட்ட கோரிக்கை உடற்பகுதிகள் (request bodies), HTTP பதில் குறியீடுகள் மற்றும் தரவு ஸ்கீமாக்கள் ஆகியவற்றைத் தெளிவாகக் காட்டுகிறது.
முக்கிய அம்சங்கள் மற்றும் திறன்கள்
- JSON மற்றும் YAML வடிவங்களில் உள்ள Swagger 2.0 மற்றும் OpenAPI 3.0 / 3.1 விவரக்குறிப்புகளை ஆதரிக்கிறது
- வகைப்படுத்தப்பட்ட எண்ட்பாயிண்ட்கள், HTTP முறைகள் மற்றும் நிலை குறியீடுகளைப் பட்டியலிடும் ஊடாடும் பக்கப்பட்டி
- உள்ளமைக்கப்பட்ட தரவு மாதிரிகள் மற்றும் பண்புக் கட்டுப்பாடுகளைக் காண்பிக்கும் ஆழமான `$ref` ஸ்கீமா தெளிவுபடுத்தல் (resolution)
- நிறுவனத்தின் தனியுரிம API ஒப்பந்தங்களைப் பாதுகாப்பாக வைத்திருக்கும் 100% கிளையன்ட்-சைட் ஆஃப்லைன் பாகுபடுத்தல்
பயன்படுத்தும் முறை
- 1
உங்கள் `swagger.json` அல்லது `openapi.yaml` உரையை ஒட்டவும், அல்லது விவரக்குறிப்பு கோப்பை நேரடியாகப் பதிவேற்றவும்.
- 2
ஊடாடும் வியூவரில் ரெண்டர் செய்யப்பட்ட கட்டமைக்கப்பட்ட API ஆவணங்களை உலாவவும்.
- 3
கோரிக்கை ஹெடர்கள், கோரிக்கை பேலோடு ஸ்கீமாக்கள் மற்றும் பதில் மாதிரிகளை ஆய்வு செய்ய ஏதேனும் எண்ட்பாயிண்ட்டை விரிவாக்கவும்.
பொதுவான பயன்பாடுகள்
- → தனித்துவமான Swagger UI சேவையகத்தை அமைக்காமலேயே பின்தள API வரையறைகளைத் தணிக்கை செய்தல்
- → சுயமாக எழுதப்பட்ட OpenAPI விவரக்குறிப்புகளில் தவறான `$ref` பாயிண்டர்கள் உள்ளதா எனச் சரிபார்த்தல்
- → API ஒருங்கிணைப்புகளின் போது ஃபிரண்ட்-எண்ட் பொறியாளர்களுக்குத் துல்லியமான ஸ்கீமா குறிப்புகளை வழங்குதல்
தொடர்புடைய கருவிகள்
HTML Meta குறிச்சொற்கள் உருவாக்கி
Open Graph மற்றும் Twitter Cards உள்ளிட்ட சமூக ஊடக மற்றும் SEO மெட்டா குறிச்சொற்களை உருவாக்கவும்.
.gitignore கோப்பு உருவாக்கி
Node, Python, Java, Go, macOS, Windows உள்ளிட்ட சூழல்களுக்கு .gitignore கோப்புகளை உருவாக்கவும்.
திறந்த மூல உரிம உருவாக்கி
MIT, Apache 2.0, GPL v3 போன்ற பிரபலமான திறந்த மூல மென்பொருள் உரிமங்களை உருவாக்கவும்.
README.md ஆவண உருவாக்கி
திட்டத் தகவல், பேட்ஜ்கள், நிறுவல் மற்றும் உரிமப் பிரிவுகளுடன் தொழில்முறை README.md ஐ உருவாக்கவும்.
Conventional Commits வழிகாட்டி
Conventional Commits விவரக்குறிப்பின்படி தரப்படுத்தப்பட்ட Git கமிட் செய்திகளை உருவாக்கவும்.
SemVer பதிப்பு கால்குலேட்டர்
Semantic Versioning விதிகளைப் பகுப்பாய்வு செய்து பதிப்பு வரம்புகளை சரிபார்க்கவும்.
அடிக்கடி கேட்கப்படும் கேள்விகள் மற்றும் தனியுரிமை
இந்தக் கருவியால் YAML விவரக்குறிப்புகளை நேரடியாகப் படிக்க முடியுமா?
ஆம். இதில் உள்ளமைக்கப்பட்ட YAML பார்சர் `.yaml` மற்றும் `.json` ஆகிய இரண்டு OpenAPI ஒப்பந்த விவரக்குறிப்புகளையும் உலாவிக்குள்ளேயே முழுமையாகச் செயலாக்குகிறது.
எனது தனியுரிம API விவரக்குறிப்பு வெளிப்புற சேவையகங்களில் பதிவேற்றப்படுமா?
இல்லை. அனைத்து ஆவணப் பாகுபடுத்தல்களும் ஸ்கீமா ரெண்டரிங்கும் உங்கள் உள்ளூர் உலாவி நினைவகத்தில் மட்டுமே செயல்படுத்தப்படுகின்றன.