首先遵循SpringBoot的三板斧
成都創(chuàng)新互聯(lián)是一家集網(wǎng)站建設(shè),芒康企業(yè)網(wǎng)站建設(shè),芒康品牌網(wǎng)站建設(shè),網(wǎng)站定制,芒康網(wǎng)站建設(shè)報(bào)價(jià),網(wǎng)絡(luò)營(yíng)銷,網(wǎng)絡(luò)優(yōu)化,芒康網(wǎng)站推廣為一體的創(chuàng)新建站企業(yè),幫助傳統(tǒng)企業(yè)提升企業(yè)形象加強(qiáng)企業(yè)競(jìng)爭(zhēng)力??沙浞譂M足這一群體相比中小企業(yè)更為豐富、高端、多元的互聯(lián)網(wǎng)需求。同時(shí)我們時(shí)刻保持專業(yè)、時(shí)尚、前沿,時(shí)刻以成就客戶成長(zhǎng)自我,堅(jiān)持不斷學(xué)習(xí)、思考、沉淀、凈化自己,讓我們?yōu)楦嗟钠髽I(yè)打造出實(shí)用型網(wǎng)站。
第一步添加依賴
<!-- SwaggerUI 接口文檔 http://{ip}:{prot}/swagger-ui.html --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>{version}</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swaggerui</artifactId> <version>{version}</version> </dependency>
第二步添加注解
@EnableSwagger2 //啟動(dòng)SwaggerUI,在啟動(dòng)類或Swagger配置類上添加該注解
第三步寫(xiě)配置
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { /* //可以添加多個(gè)header或參數(shù) ParameterBuilder aParameterBuilder = new ParameterBuilder(); aParameterBuilder //參數(shù)類型支持header, cookie, body, query etc .parameterType("header") //參數(shù)名 .name("user-token") //默認(rèn)值 .defaultValue("t122222") .description("用戶登錄憑證") //指定參數(shù)值的類型 .modelRef(new ModelRef("string")) //非必需,這里是全局配置 .required(false).build(); List<Parameter> aParameters = new ArrayList<>(); aParameters.add(aParameterBuilder.build()); */ return new Docket(DocumentationType.SWAGGER_2) // return new Docket(DocumentationType.SPRING_WEB) .apiInfo(apiInfo()) .pathMapping("/") .select()// 選擇那些路徑和api會(huì)生成document .apis(RequestHandlerSelectors.any())// 對(duì)所有api進(jìn)行監(jiān)控 // 不顯示錯(cuò)誤的接口地址 .paths(Predicates.not(PathSelectors.regex("/error.*")))// 錯(cuò)誤error路徑不監(jiān)控 .paths(Predicates.not(PathSelectors.regex("/actuator.*")))// 錯(cuò)誤error路徑不監(jiān)控 .paths(PathSelectors.regex("/.*"))// 對(duì)根下所有路徑進(jìn)行監(jiān)控 .paths(PathSelectors.any()) // 對(duì)所有路徑進(jìn)行監(jiān)控 // 自行修改為自己的包路徑 // .apis(RequestHandlerSelectors.basePackage("com.happyloves.zc.service.account.api")) .build() // .globalOperationParameters(aParameters) .enable(true); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("API接口") .description("API接口文檔") //服務(wù)條款網(wǎng)址 // .termsOfServiceUrl("https://www.google.com") .version("1.0") // .contact(new Contact("啦啦啦", "url", "email")) .build(); } }
擴(kuò)展:swagger-bootstrap-ui是springfox-swagger的增強(qiáng)UI實(shí)現(xiàn),為Java開(kāi)發(fā)者在使用Swagger的時(shí)候,能擁有一份簡(jiǎn)潔、強(qiáng)大的接口文檔
體驗(yàn)項(xiàng)目地址碼云:https://gitee.com/xiaoym/swagger-bootstrap-ui
GitHub: https://github.com/xiaoymin/Swagger-Bootstrap-UI
在線體驗(yàn):http://swagger-bootstrap-ui.xiaominfo.com/doc.html
代碼集成示例
SpringBoot在線demo地址:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo
Spring Mvc在線demo地址:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo/tree/master/swagger-bootstrap-ui-demo-mvc
添加依賴
<!-- swagger-bootstrap-ui是 Swagger 的增強(qiáng)UI 實(shí)現(xiàn),使文檔更友好一點(diǎn)兒 http://{ip}:{prot}/doc.html --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.9.6</version> </dependency>
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持創(chuàng)新互聯(lián)。
當(dāng)前名稱:SpringBoot整合Swagger2代碼實(shí)例
分享URL:http://redsoil1982.com.cn/article18/ghhcgp.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供網(wǎng)站營(yíng)銷、網(wǎng)站策劃、App開(kāi)發(fā)、品牌網(wǎng)站建設(shè)、手機(jī)網(wǎng)站建設(shè)、電子商務(wù)
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)