Swagger bu restful api larni ishlab chiqish va tavsiflash uchun ochiq manbali qoidalar
Download 1.04 Mb. Pdf ko'rish
|
8-Swagger
|
Swagger2 Swagger2 konfiguratsiya Loyihamizni ishga tushiramiz va browserda http://localhost:8080/v2/api-docs ga so`rov jo`natamiz, agar sizda quyidagi holat yuz bersa demak Swagger2 ishlamoqda. Swagger2 Swagger2 Endi browserda http://localhost:8080/swagger-ui.html ga so`rov jo`natamiz va bizda quyidagi Swagger2 ning foydalanuvchi oynasi paydo bo`ladi. Unda biz o`zimiz yozgan API larimizga so`rovlarimizni jo`natishimiz hamda API dan kelgan ma`lumotlarni ko`rishimiz mumkin. Swagger2 2 1 Swagger2 Swagger2 Swagger2 annotatsiyalari @ApiOperation - Ushbu izoh ochiq REST API tavsifi uchun ishlatiladi. U quyidagi parametrlarni oladi : value - API ga qisqacha tavsifdir. notes - eslatmalar sizga operatsiyalar haqida sezilarli darajada ko`proq ma`lumot berishga imkon beradi (masalan, so`rov namunalari va javoblarni shu yerga kiritishingiz mumkin …) nickname - API uchun taxallus. Swagger2 annotatsiyalari Swagger2 annotatsiyalari @ApiResponses - Ushbu izoh REST API uchun kutilgan javoblarni tavsiflash uchun ishlatiladi. @ApiResponse aniq mumkin bo`lgan javobni tavsiflaydi. U to`g`ridan-to`g`ri usulda ishlatilmaydi va @ApiResponses massiv qiymatiga kiritilishi kerak (bir yoki undan ortiq javob bo`ladimi). U quyidagi parametrlarni oladi – ApiResponse - @ApiResponse aniq mumkin bo`lgan javobni tavsiflaydi. Swagger2 annotatsiyalari Swagger2ning @ApiParam,@ApiModel,@ApiModelProperty,@Authorization,@AuthorizationScope, @Api, @ApiImplicitParam, @ApiImplicitParams kabi ko`plab annotatsiyalari mavjud bo`lib ular bilan quyidagi link orqali tanishishingiz mumkin: Swagger2 annotatsiyalari https://github.com/swagger-api/swagger-core/wiki/Annotations Swagger3 (Open API) Swagger3 - bu OpenApi spetsifikatsiyasining xususiyatini amalga oshiradigan ochiq manbali vosita. Swagger ilovada ishlatiladigan REST api spetsifikatsiyasi uchun samarali vositadir. Shuningdek, u chiqishni ko`rsatish kabi bir nechta funktsiyalarni taqdim etadi. Swagger dastur ishlab chiquvchilar o`rtasidagi aloqa uchun samarali vosita bo`lib xizmat qilishi mumkin bo`lgan hujjat sifatida ishlaydi. Swagger yordamida har bir kishi dasturchi yoki mijoz bo`ladimi, API bilan osongina o`zaro aloqada bo`lishi mumkin. Biz Maven pom.xml (Project Object Model) faylini yaratishdan boshlashimiz kerak. Pom.xml faylida loyiha konfiguratsiyasi tafsilotlari mavjud. Swaggerni sozlash uchun dasturimizda Open Api spetsifikatsiyasiga quyidagi bog`liqlikni (dependency) qo`shishimiz kerak. Download 1.04 Mb. Do'stlaringiz bilan baham: 
|