.NET Uzbekistan
  • .NET Uzbekistan
  • C# / .NET
    • .NET ga xush kelibsiz
    • .NET bilan bog'liq mavhumliklardan qochish
    • .NET asoslari
      • MSIL
      • Memory Management
        • Stack & Heap
      • CLR
    • Basics
      • Starter (boshlang'ich)
        • Java vs C#
        • C# Tarixi
        • Kirish
        • Visual Studio 2019
        • O'zgaruvchilar
        • Ma'lumot turlari
        • Operatorlar
        • Kalit so'zlar
        • ReadLine
        • If-else
        • Switch
        • Math sinfi
        • For sikl operatori
        • While sikl operatori
        • Do-While sikl operatori
        • Foreach sikl operatori
        • Break
        • Continue
        • Goto
        • Kommentlar
      • Essential (muhim)
        • Funksiya
        • Funksiyani qiymat orqali chaqirish
        • Funksiyada Ref kalit so'zidan foydalanish
        • Funksiyada Out parametri
        • Massiv
        • Funksiyalarda massivdan foydalanish
        • Ko'p o'lchamli massiv
        • Parametrlar
        • Array sinfi
        • CMD argumentlari
        • Obyekt va Class lar
        • Konstruktor
        • Obyektni ishga tushiruvchilar
        • Destructor
        • this
        • static
        • Struct
        • Enum
        • Property va Field lar
        • Vorislik
        • Overload (Qayta yuklash)
        • Override (Qayta yozish)
        • Base
        • Polimorfizm
        • Sealed
        • Interface
        • Modifikatorlarga ruxsat berish
        • Inkapsulatsiya
        • Abstrakt class va funksiyalar
        • String
        • StringBuilder
        • String Intern Pool
        • Exception Handling
        • try/catch
        • finally
      • Professional
        • To'plamlar
          • List
          • ArrayList
          • LinkedList
          • SortedList
          • Dictionary
          • HashTable
          • Stack
          • Queue
        • Tuple
        • ValueTuple
        • Delegatlar
          • Func delegati
          • Action delegati
          • Predicate delegati
          • Anonim metodlar
        • Hodisalar
        • Extension metodlar
        • Stream I/O
          • StreamWriter
          • StreamReader
          • MemoryStream
        • File va Directory
          • FileInfo
          • DirectoryInfo
        • MultiThread va Parallel dasturlash
        • Asinxron dasturlash
        • XML Document bilan ishlash
    • LINQ asoslari
      • Average
      • LINQ qanday ishlaydi?
      • LINQ query yozish usullari
      • IEnumerable va IQuerable
      • LINQ operatorlari
      • Select
      • SelectMany
      • Filterlash operatorlari
      • Where
      • OfType
      • Saralash operatorlari
      • OrderBy va OrderByDescending
      • ThenBy va ThenByDescending
      • Reverse
      • Miqdor operatorlari
        • All
        • Any
        • Contains
        • Min
        • Max
      • Set operatsiyasi
        • Distinct
        • Except
        • Intersect
        • Union
      • Bo'lim operatorlari
        • Take
        • TakeWhile
        • Skip
        • SkipWhile
      • Join operatorlari
        • Inner Join
        • Group Join
        • Left Join
      • Element operatsiyalari
        • ElementAt
        • First va FirstOrDefault
        • Last va LastOrDefault
        • Single va SingleOrDefault
    • ORM
      • ADO.NET
      • Dapper
      • Entity Framework
        • Entity Framework Approaches(usullar)
          • Model First Approach
          • Database First Approach
          • Code First Approach
        • Query yozish usullari(Entity Framework)
          • LINQ to SQL
          • Entity SQL
          • Native SQL
        • Entity Framework Core
    • Qo'shimcha sinflar
      • System.Text
        • Encoding
      • System
        • Int32
        • Random
        • DateTime
        • TimeSpan
      • System.Reflection
    • .NET Dasturchi
      • Clean Arxitektura
        • Clean Kod
        • Dizayn Tamoyillari
          • SOLID
            • Yagona Mas'uliyat Tamoyili(SRP)
            • Ochiq Yopiq Tamoyili(O/CP)
            • Liskovning Almashtirish Tamoyili(LSP)
            • Interfeysga ajratish tamoyili(ISP)
            • Qaramlik Inversiya Tamoyili(DIP)
          • DRY
          • KISS
          • YAGNI
        • Dizayn Patternlar
          • Factory Method
          • Abstract Factory
          • Builder
          • Prototype
          • Singleton
          • Adapter
          • Bridge
          • Composite
          • Decorator
          • Façade
          • Flyweight
          • Proxy
          • Chain of Responsibility
          • Command
          • Interpreter
          • Iterator
          • Mediator
          • Memento
          • Observer
          • State
          • Strategy
          • Visitor
          • Template Method
      • Git / Github
      • Muhim terminlar
      • Postman
      • CLI
        • CMD savodxonligi
      • API dan foydalanish
      • WCF
      • Refactor .NET application
      • Unit Test
      • TDD
      • TFS
    • Desktop Dasturlash
      • WPF (Windows Presentation Foundation)
        • WPF ga kirish
          • WPF ning ustunliklari
          • WPF da dastur
          • WPF arxitetkturasi
          • Klasslar iorarxiyasi
        • XAML
          • XAML asoslari
          • XAML orqasida kod
          • XAML xususiyatlari
          • XAML belgilash kengaytmalari
          • Biriktirilgan xususiyatlar
          • XAML da hodisalar
          • XAML da nomlar fazosi
        • WPF ilovasini tuzish
          • Komponovka
          • StackPanel
          • WrapPanel
          • DockPanel
          • Grid
          • GridSplitter
          • Umumiy o'lchamli guruhlar
          • Canvas
          • LnkCanvas
          • Komponovkaga misollar
        • Bog'liqlik xususiyatlari (Dependency property)
          • Bog'liqlik xususiyatlari
          • Bog'liqlik xususiyatlarining roli
          • Bog'liqlik xususiyatlarining aniqlanishi
          • Bog'liqlik xususiyatlarini ishlatish
        • Marshrutlangan hodisalar (Routed Events)
          • Routed Events
          • Bubble Events
          • Direct Events
          • Tunneling Events
        • Qo'shimcha ma'lumotlar
          • WPF ga kirish
          • WinForm va WPF
          • Salom WPF
          • XAML nima?
          • Hodisalar
          • WPF oynasi
          • App.xaml
          • Resurslar
          • Argument berish
          • Son va Vaqtni Formatlash
          • TextBlock elementi – Inline formatlash
          • Label elementi
          • Textbox elementi
      • WinForm (Windows Form)
        • 1-dars. Forma yaratish
        • 2-dars. Muhit bilan tanishish
        • 3-dars. Formaga komponentalar joylashtirish
        • 4-dars. Xodisa(Event)larni boshqarish
        • 5-dars. Dasturni ishga tushurish
      • UWP (Universal Windows Platform)
      • Xamarin
    • Web Dasturlash
      • ASP.NET Core asoslari
        • ASP.NET Core haqida
        • Loyihalar turlari
        • ASP.NET Core dasturlarini hosting qilish
        • Middleware tushunchasi
        • Middleware bilan amaliyot
        • Statik fayllar bilan ishlash
        • Dependency Injection
        • Developer Exception Page
      • ASP.NET Core Web API
        • Web API ga kirish
        • Swagger nima?
        • Http metodlar
        • ActionResult
        • CORs
        • Security (JWT)
        • Swagger ni sozlash
        • Filter va atributlar
        • Configuration va middleware
        • Logging
        • Mapping (AutoMapper)
        • SignalR
        • Keshlash
      • ASP.NET Core MVC
        • MVC nima?
        • ASP.NET Core MVC haqida qisqacha
        • Loyiha strukturasi
        • Controller
        • View
        • Model
        • View larni aniqlash yo'llari
        • Controller dan view ga ma'lumot uzatish
        • ViewBag va ViewData
        • Strongly typed View
        • Layout view haqida
        • ViewStart va ViewImports fayllari haqida
        • Marshrutizatsiya (routing)
        • Tag Helpers
          • Anchor Tag Helper
          • Image Tag Helper
          • Environment Tag Helper
        • Tekshiruv qoidalari (Validation rules)
      • MicroServices
    • Mobile Dasturlash
      • Xamarin.Android
      • Xamarin.IOS
      • Xamarin.Forms
    • Game Dasturlash
      • Unity Starter (boshlang'ich)
      • Unity Advanced (rivojlangan)
    • Internet of Things
    • Machine Learning
    • Telegram Bot
      • Kirish
        • Telegram bot bilan tanishuv
        • ASP.NET Core da birinchi telegram bot
      • Starter
        • Xabar turlari va xabar yuborish
          • Matnli xabarlar bilan ishlash
          • Rasm & Sticker
          • Audio & voice
          • Video & Video Note
          • Dokument fayllar
          • Polls
          • Contact , Location, Venue
          • Album(Media Group)
      • Essential
        • Reply - Markup
          • ReplyKeyboardMarkup, KeyboardButton
          • InlineKeyboardMarkup, InlineKeyboardButton
      • Advanced
        • Deployment
    • Class Library
    • Intervyu savollari
      • C# / .NET asoslari
  • Database
    • MS SQL Server
      • SQL Server sintaksisi
      • Ma'lumot turlari
      • Select
    • PostgreSQL
      • Basic
        • Kirish
        • PostgreSQL tarixi
        • Muhitni sozlash (PgAdmin)
        • Sistaksis
        • Ma'lumot turlari
        • Create Database
        • Select Database
        • Drop Database
        • Create Table
        • Drop Table
        • Scheme
        • Insert so'rovi
        • Select so'rovi
        • Operatorlar
        • Ifodalar
        • Where
        • Where
        • And va Or
        • Update so'rovi
        • Delete so'rovi
        • Like
        • Limit
        • Order By
        • With
        • Having
        • Distinct
      • Advance
        • Constraint (cheklov) lar
        • Join lar
          • Cross join
          • Inner join
          • Left join
          • Right join
          • Full join
        • Union
  • Roadmap
    • Roadmap for .NET developers
    • Roadmap for Azure developers
Powered by GitBook
On this page
  • Swagger-dan kim foydalanadi
  • Spetsifikatsiya qanday ishlaydi
  • Swagger-dan foydalanishning afzalliklari

Was this helpful?

  1. C# / .NET
  2. Web Dasturlash
  3. ASP.NET Core Web API

Swagger nima?

Jaloliddin Axmedov

PreviousWeb API ga kirishNextHttp metodlar

Last updated 2 years ago

Was this helpful?

Swagger loyihasi 2015-yilda OpenAPI tashabbusiga sovg‘a qilingan va shu vaqtdan boshlab OpenAPI deb nomlanadi. Ikkala ism ham bir-birining o'rnida ishlatiladi. Biroq, "OpenAPI" spetsifikatsiyaga ishora qiladi. "Swagger" SmartBear kompaniyasining OpenAPI spetsifikatsiyasi bilan ishlaydigan ochiq manbali va tijorat mahsulotlari oilasiga ishora qiladi. Keyingi ochiq manbali mahsulotlar, masalan, OpenAPIGenerator , SmartBear tomonidan chiqarilmaganiga qaramay, Swagger familiyasiga ham tegishli.

Qisqasi:

OpenAPI - bu spetsifikatsiya. Swagger - bu OpenAPI spetsifikatsiyasidan foydalanadigan asbob. Masalan, OpenAPIGenerator va SwaggerUI.

Swagger-ning asosiy maqsadi odamlar va mashinalar uchun tushunarli bo'lgan hujjatlarni avtomatik ravishda yaratishdir. Shunga ko'ra, u ko'pincha API kodini tez va oson hujjatlashtirish uchun ishlatiladi. Odatda RESTful API arxitekturasi bilan birgalikda ishlatiladi .

API ishlab chiqish. Swagger, masalan, ishlab chiquvchi mahsulotni takomillashtirishda hujjatlarga murojaat qilishi kerak bo'lganda yoki uni koddan yaratmoqchi bo'lganda ishlatiladi. Ba'zan teskari jarayon talab qilinadi - Swagger Codegen komponenti tufayli mumkin bo'lgan hujjatlar asosida kod yaratish. Bu haqda quyida gaplashamiz.

API o'zaro ta'siri. Kod yaratish qobiliyati boshqa loyihalarning API bilan o'zaro aloqada bo'lganda ishlatiladi. Swagger Codegen oxirgi mijoz uchun API bilan ishlaydigan kodni yaratishi mumkin - bu vaqtni tejash maqsad bo'lganda qulaydir.

API uchun Swagger spetsifikatsiyasini qo'lda yozishingiz yoki uni manba kodingizdagi izohlardan avtomatik ravishda yaratishingiz mumkin.

Shunday qilib, API uchun Swagger spetsifikatsiyasi bor.

Swagger API rivojlanishini yanada rivojlantirishga yordam beradigan bir necha usullar mavjud:

  • Birinchi dizayn foydalanuvchilari: API uchun server stubini yaratish uchun Swagger Codegen- dan foydalaning. Faqatgina server mantiqini amalga oshirish qoladi - va sizning API jonli ishlashga tayyor!

  • API uchun 40 dan ortiq tillarda mijozlar kutubxonalarini yaratish uchun Swagger Codegen- dan foydalaning .

  • Interfaol API hujjatlarini yaratish uchun Swagger UI dan foydalaning , bu foydalanuvchilarga API qo‘ng‘iroqlarini bevosita brauzerda sinab ko‘rish imkonini beradi.

  • API bilan bog'liq vositalarni API-ga ulash uchun spetsifikatsiyadan foydalaning. Masalan, API uchun avtomatlashtirilgan testlarni yaratish uchun spetsifikatsiyani SoapUI -ga import qiling.

  • Va yana! Swagger bilan integratsiyalashgan ochiq manbali va tijorat vositalarini ko'rib chiqing .

Swagger-dan kim foydalanadi

  • Loyihaning API-ni tezda hujjatlashtirishni xohlaydigan va hujjatlarni noldan yozishga vaqt ajrata olmaydigan dasturchilar.

  • Uchinchi tomon dasturiy mahsulotining API-ni joriy qilmoqchi bo'lgan ishlab chiquvchilar - ular hujjatlardan, shu jumladan Swagger-da yaratilganlardan foydalanadilar.

  • Loyihalar uchun hujjatlarni yaratishda texnik yozuvchilar - asosiy yoki yordamchi vosita sifatida.

Spetsifikatsiya qanday ishlaydi

Ob'ekt, foydalanuvchi nomi, modul nomi, havola yoki boshqa narsa bo'lishi mumkin. Sakkizta asosiy ob'ekt mavjud; qolganlari ular ichida joylashgan:

  • openapi. Uning qiymati loyihada ishlatiladigan OpenAPI versiyasidir;

  • ma'lumot. API haqida asosiy ma'lumotlarni o'z ichiga olgan ichki o'rnatilgan ob'ektlarni o'z ichiga oladi: ism, tavsif, litsenziya, ishlab chiquvchi kontaktlari va boshqalar;

  • serverlar. Serverlarga olib boradigan havolalarni o'z ichiga oladi - so'nggi nuqtalardan qat'iy nazar tashqaridan kirish uchun asosiy yo'llar;

  • yo'llar. Yakuniy nuqtalarni yoki so'nggi nuqtalarni (oxirgi nuqtalarni) tavsiflaydi - ma'lum bir ob'ektga boradigan yo'lning oxiri. Har bir so'nggi nuqta uchun GET, POST, DELETE va PUT so'rovlari yoziladi - ob'ekt bilan o'zaro aloqa qilish operatsiyalari;

  • komponentlar. U hujjatlarning turli joylarida ishlatilishi mumkin bo'lgan sxemalarni saqlaydi. Masalan, "Ism", "Manzil" va boshqalar maydonlari bilan "Foydalanuvchi" sxemasini yaratishingiz mumkin. Komponentlarda tavsiflanganidan so'ng, sxema hujjatlar kodida qo'shimcha ravishda ishlatilishi mumkin;

  • teglar. Teg metama'lumotlarini saqlaydi: sarlavha, tavsif va boshqalar. Nima bo'layotganini batafsilroq tasvirlashga yordam beradi;

  • xavfsizlik. API bilan ishlatilishi mumkin bo'lgan xavfsizlik usullarini tavsiflaydi;

  • externalDocs. Odatda qo'shimcha ma'lumotlarga ega bo'lgan tashqi hujjatlarga havolalarni o'z ichiga oladi. Masalan, bu kodda ishlatiladigan uchinchi tomon vositalarining hujjatlari bo'lishi mumkin.

Swagger-dan foydalanishning afzalliklari

  • Swagger hujjatlarni yozishni soddalashtiradi va tezlashtiradi, ishlab chiquvchilar va texnik yozuvchilar uchun vaqtni tejaydi.

  • Siz uy ishlarini qisqartirishingiz va Swagger Codegen-ni ishlab chiqarishga ruxsat berishingiz mumkin: bu yana vaqtni tejaydi.

  • Hujjatlar barcha toifadagi o'quvchilar uchun batafsil va tushunarli: texnik mutaxassislar, oddiy foydalanuvchilar va robotlar.

  • Siz Swagger-dan juda moslashuvchan foydalanishingiz mumkin: kod yoki o'zingizga asoslangan hujjatlarni yarating, sinov va tezkor navigatsiya uchun vizual interfeys imkoniyatlaridan foydalaning.

  • Swagger bilan yozilgan hujjatlar veb-sayt sahifasi yoki ilovasiga osongina joylashtirilishi mumkin va interaktiv va to'liq ishlaydi. Ammo displeyning o'z versiyasini yaratish yaxshiroqdir - standart interfeys haqiqiy saytlarning dizayniga unchalik mos kelmaydi.