Swagger bu restful api larni ishlab chiqish va tavsiflash uchun ochiq manbali qoidalar
Download 1.04 Mb. Pdf ko'rish
|
8-Swagger
Reja: 1.Swagger Swagger - bu RESTful API larni ishlab chiqish va tavsiflash uchun ochiq manbali qoidalar, spetsifikatsiyalar va vositalar to`plamidir. Swagger dastur ishlab chiquvchilarga interaktiv, mashina va inson o`qiy oladigan API hujjatlarini yaratishga imkon beradi. API spetsifikatsiyalari odatda qo`llab-quvvatlanadigan operatsiyalar, parametrlar va natijalar, avtorizatsiya talablari, zarur litsenziyalar kabi ma`lumotlarni o`z ichiga oladi. Swagger ushbu ma`lumotni API dan o`z izohlaridan hujjat faylini qaytarishni so`rab manba kodidan avtomatik ravishda yaratishi mumkin. Swagger foydalanuvchilarga RESTful veb-xizmatlarini yaratish, hujjatlashtirish, sinab ko`rish va foydalanishga yordam beradi. Swagger Swagger komponentlari Swagger API uchun turli xil ochiq manba vositalarini taqdim etadi, jumladan: Swagger Editor- bu dastur ishlab chiquvchilarga yangi API lar uchun hujjatlar yozish, loyihalash va tavsiflash hamda mavjudlarini tahrirlash imkonini beradi. Brauzerga asoslangan muharrir OpenAPI spetsifikatsiyalarini vizual tarzda taqdim etadi, xatolarni hal qiladi va real vaqtda fikr-mulohazalarni taqdim etadi. Swagger Codegen - bu dastur ishlab chiquvchilarga turli platformalar uchun mijozlar kutubxonasi kodi va SDK yaratish qobiliyatini beradi. Swagger User Interface - bu muhandislarga turli platformalar uchun hujjatlarni yaratishda yordam beradigan to`liq moslashtirilgan vositadir. U har qanday muhitda joylashtirilishi mumkin. Swagger Inspector - bu API hujjatlari uchun sinov vositasi. API larni cheklovsiz osongina tekshirish mumkin va natijalar avtomatik ravishda cloudda saqlanadi va ularga kirish mumkin. Swaggerning afzalliklari API amaliyotlarini standartlashtirish va soddalashtirish maqsadiga qo`shimcha ravishda, Swaggerning bir nechta qo`shimcha afzalliklari mavjud, ular quyidagilar: • U API lar rejasini tuzadigan foydalanuvchi interfeysiga ega. • Hujjatlar mijozlar yoki loyiha menejerlari kabi ishlab chiquvchilar uchun ham, ishlab chiqmaydiganlar uchun ham tushunarli. • Texnik xususiyatlar inson va mashina tomonidan o`qilishi mumkin. • Interaktiv, oson tekshiriladigan hujjatlarni yaratadi. • 40 dan ortiq tillarda API kutubxonalarini yaratishni qo`llab-quvvatlaydi. • Oson tahrirlarni yoqish uchun JSON va YAML formatida qabul qilinadi . • API bilan bog`liq jarayonlarni avtomatlashtirishga yordam beradi. Swagger tarixi Swagger API loyihasi 2011 yilda Toni Tam tomonidan Wordnik lug`at veb-sayti uchun vositalarni ishlab chiqish paytida yaratilgan. U API ni avtomatlashtirish va uning hujjatlarini osonlashtirish uchun ishlab chiqilgan. Keyin loyiha ochiq manbaga aylantirildi va u kompaniyalar va ishlab chiquvchilar orasida qiziqish uyg`otdi. 2015-yilda Swagger, SmartBear Softwarega xizmat ko`rsatuvchi kompaniya Linux Foundation homiyligidagi OpenAPI tashabbusini yaratishga yordam berdi. Bir yil o`tgach, Swagger nomi OpenAPI Spetsifikatsiyasiga o`zgartirildi va yangi GitHub omboriga ko`chirildi. Swagger hozirda umumiy tilga ega API larni loyihalash uchun eng katta framework hisoblanadi. API ishlab chiquvchilari so`nggi bir necha yil ichida API larni aniqlash uchun Swagger 2.0 spetsifikatsiyasidan foydalanib kelishmoqda. Keyinchalik u Linux fondiga topshirildi va Open API spetsifikatsiyasi deb nomlandi va Open API 3.0 kabi ko`plab yangi xususiyatlar va yaxshilanishlar bilan yangi versiya chiqarildi. Swagger 2.0 bilan solishtirganda, Open API spetsifikatsiyasi APIni aniqlashda modulliroq va qayta foydalanish mumkin va so`rovga javob modellari va asosiy xavfsizlik ma`lumotlarini tavsiflashda kuchliroqdir. Swagger Swagger2 (Open API 2) dan foydalanib ko`rish uchun yangi Spring boot loyiha yaratamiz va loyihamizning pom.xml filega quyidagi dependency larni qo`shamiz. Download 1.04 Mb. Do'stlaringiz bilan baham: |
Ma'lumotlar bazasi mualliflik huquqi bilan himoyalangan ©fayllar.org 2024
ma'muriyatiga murojaat qiling
ma'muriyatiga murojaat qiling