مثال على استخدام Swagger2 في Spring Boot Project

تقدم هذه المقالة مثالًا على استخدام Swagger2 في Spring Boot Project. تتم مشاركتها معك. التفاصيل كما يلي:

إضافة التبعيات Swagger2

إضافة تبعيات Swagger2 في pom.xml

 <Rependency> <roupEd> io.springfox </rougiD> <StifactId> springfox-swagger2 </shintifactid> <sophy> 2.2.2 </version> </repreadency> <sependency> <groupid> io.springfox </groupid>

قم بإنشاء فئة تكوين Swagger2

إنشاء فئة التكوين Swagger2 Swagger2 في Application.Java المستوى المتزامن.

 استيراد org.springframework.context.annotation.bean ؛ استيراد org.springframework.context.annotation.configuration springfox.documentation.service.apiinfo ؛ استيراد springfox.documentation.spi.documentationtype ؛ {return new docket (documentationType.swagger_2) .ApiInfo (apiinfo ()) .select () .Apis (requestHandlersElectors.BasePackage ("اسم حزمة الواجهة الخارجية الخاصة بك")) .paths (pathselectors.any ()) .build () ؛ } apiinfo apiinfo () {return جديد apiinfobuilder () .Title ("Neo4J Restful Apis") .Description ("Neo4J Restful Apis Description/") .Build. }}

أضف محتوى المستند

بعد الانتهاء من التكوين أعلاه ، يمكن بالفعل إنتاج محتوى المستند ، ولكن هذه المستندات تهدف بشكل أساسي إلى الطلب نفسه ، ويأتي الوصف بشكل أساسي من تسمية الوظائف والوظائف الأخرى ، والتي ليست سهلة الاستخدام. عادة ما نحتاج إلى إضافة بعض الإرشادات لإثراء محتوى المستند.

 استيراد io.swagger.annotations.api ؛ استيراد io.swagger.annotations.ApiOperation ؛ import io.swagger.annotations.apiparam ؛/** * System User Controller * * Author li Qinghai * */@api (value = "واجهة مستخدم النظام" ، العلامات = "إدارة النظام") UserController {Autowired private userviceervice ؛ /** * إضافة مستخدم ، سجل * * param loginname * تسجيل الدخول إلى حساب * param username * اسم المستخدم * param password * login password * param or or or or or or sturn * @throws resourceExiStception */apiOparam الحساب "، مطلوب = صواب) @requestparam (مطلوب = صواب) @requestbody سلسلة logInName ، apiParam (name =" username "، value =" اسم المستخدم "، مطلوب = صحيح) @requestparam (مطلوب = true) @requestphody username ، apiParam (name =" value = "log in in apiParam (name = "roalId" ، value = "رقم دور المستخدم" ، مطلوب = صواب) requestparam (مطلوب = صواب) @requestbody string rowiD) يلقي ResourceExistsexception {boolean موجود = this.userservice.exists (loginName) ؛ إذا (موجود) {رمي New ResourceExiStSexception (logInName) ؛ } user user = userservice.create (logInName ، كلمة المرور ، اسم المستخدم ، rolyId) ؛ إرجاع New JsonResult (المستخدم) ؛ }}

عرض API

ابدأ برنامج SPRING BOOT وزيارة: http: // localhost: 8080/swagger-ui.html

وثيقة وثيقة API وتصحيح الأخطاء

بالإضافة إلى عرض وظيفة الواجهة ، يوفر Swagger أيضًا وظائف التصحيح والاختبار. يمكننا النقر فوق مخطط النموذج (المنطقة الصفراء: يشير إلى بنية البيانات) على اليمين في الصورة أعلاه. في هذا الوقت ، هناك قالب لكائن المستخدم في القيمة. نحتاج فقط إلى تعديله قليلاً ، انقر فوق تجربته أدناه! زر ، يمكنك إكمال مكالمة طلب! يمكن استخدام العديد من طلبات الحصول على طلب للتحقق من أن طلب النشر السابق صحيح.

ما سبق هو كل محتوى هذه المقالة. آمل أن يكون ذلك مفيدًا لتعلم الجميع وآمل أن يدعم الجميع wulin.com أكثر.