اختيال
Swagger هي مواصفات مستقلة عن اللغة وإطار عمل يستخدم لتحديد واجهات الخدمة ويستخدم بشكل أساسي لوصف واجهات برمجة التطبيقات المريحة. إنه يركز على إنشاء وثائق ممتازة ومكتبات عملاء لواجهة برمجة التطبيقات. يمكن لواجهة برمجة التطبيقات التي تدعم Swagger إنشاء مستندات تفاعلية لطرق API ، مما يسمح للمستخدمين باكتشاف وظائف API من خلال التجربة بصريًا وعرض الطلبات والاستجابات وملفات الرأس ورموز الإرجاع.
يتم استخدام Swagger لتحديد وثائق API.
فائدة:
Springboot تضمين Swaggerui
خطوة
1. جار حزمة مقدمة
<Rependency> <roupEd> io.springfox </groupId> <StifactId> Springfox-swagger-ui </shintifactid> <الإصدار> 2.2.2 </version> <scope> ترجمة </scope> </spensidency> <sperence> <roupend> io.springfox </groupid> <splection> 2.2.2 </version> <scope> ترجمة </scope> </premency>
2. تكوين SwaggerConfig استنادًا إلى Springboot
@configuration @enbleswagger2public class SwaggerConfig {bean public docket newsapi () {// return docket new (documentationType.swagger_2) .Apiinfo (apiinfo ()). select (). paths (pathselectors.any ()). build () ؛ docket docket = docket جديد (DocumentationType.swagger_2) ؛ docket.enable (صحيح) ؛ docket.apiinfo (apiinfo ()). select (). المسارات (pathselectors.any ()). build () ؛ جدول العودة } apiinfo apiinfo () {إرجاع apiinfobuilder () .TermsofServiceUrl ("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm؟open") .Contact ("test") .license ( }}3. تعليمات تكوين WebConfig
هناك مشكلة يجب الانتباه إلى هنا. دع WebConfig يرث webmvcautoconfigurgurationAdapter بدلاً من وراثة WebMVCConfigureRadapter مباشرة ، وإلا فلن يتم إصدار صفحة Swagger.
@configuration @enableWebmvCpublic Class WebConfig يمتد webmvcautoconfigurationAdAdapter {Override public void addCorsMappings (سجل corsregistry) {registry.addmapping ("/**") ؛ } bean static static propertysourcesholderConfigurer propertySourCesholderConfigurer () {return new PropertySourcePlaceholderConfigurer () ؛ } bean public filter directionencodingfilter () {distaryenCodingFilter distractOdingFilter = new disearenCodingFilter () ؛ directionencodingfilter.setencoding ("UTF-8") ؛ characterencodingfilter.setForceenCoding (صواب) ؛ إرجاع حرف encorencodingfilter ؛ } bean public mappingjackson2httpmessageconverter converter () {mappingjackson2httpmessageConverter converter = new MapPingJackson2HttpMessageConverter () ؛ محول الإرجاع ؛ } bean public viewResolver getViewResolver () {internalResourceViewResolver Resolver = new InternalResourceViewResolver () ؛ Resolver.setViewClass (jstlview.class) ؛ Resolver.setPrefix ("/JSP") ؛ Resolver.SetSuffix (". JSP") ؛ إرجاع محلول ؛ } bean public publicervletmultipartresolver getStAndardServletMultiPartresolver () {return new stisterServletMultiPartresolver () ؛ }}4.
http: // localhost: 8080/projectName/swagger-ui.html#!/
ما سبق هو كل محتوى هذه المقالة. آمل أن يكون ذلك مفيدًا لتعلم الجميع وآمل أن يدعم الجميع wulin.com أكثر.