最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

springboot項(xiàng)目集成swagger-bootstrap-ui全過程

 更新時(shí)間:2023年05月26日 11:00:13   作者:小棟喲  
這篇文章主要介紹了springboot項(xiàng)目集成swagger-bootstrap-ui全過程,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

springboot項(xiàng)目集成swagger-bootstrap-ui

Swagger 是一個(gè)規(guī)范和完整的框架,用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù)。

總體目標(biāo)是使客戶端和文件系統(tǒng)作為服務(wù)器以同樣的速度來更新。

作用

接口的文檔在線自動(dòng)生成,功能測試(特別是前后端分離項(xiàng)目,為與前端同學(xué)合作提供了很大的方便)。

本篇內(nèi)容主要記錄swagger配置,頁面為swagger-bootstrap-ui 頁面。

配置

第一步

配置pom.xml

         <!-- swagger2  -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>
        <!-- 引入swagger-bootstrap-ui包 -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.8.5</version>
        </dependency>

第二步

使用注解來進(jìn)行啟動(dòng)swagger,添加配置類SwaggerConfig 

package cn.cnic.zhongtai.system.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
*
* Created  by wdd on 2019/11/1
*
**/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        //http://ip地址:端口/項(xiàng)目名/swagger-ui.html#/
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("項(xiàng)目名稱") //網(wǎng)站標(biāo)題
                .description("項(xiàng)目名稱swagger RESTful APIs......") //網(wǎng)站描述
                .version("9.0") //版本
                .contact(new Contact("王棟棟","https://blog.csdn.net/Xiaodongge521","wangdongdong0224@163.com")) //聯(lián)系人
                .license("The Apache License") //協(xié)議
                .licenseUrl("http://www.baidu.com") //協(xié)議url
                .build();
        return new Docket(DocumentationType.SWAGGER_2) //swagger版本
                .pathMapping("/")
                .select()
                //掃描那些controller
                .apis(RequestHandlerSelectors.basePackage("cn.cnic.zhongtai.system.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo);
    }
}
 

第三步

配置Controller的注解和方法上的注解,最下方有注解的詳細(xì)解釋;

import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.apache.commons.lang3.StringUtils;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
*
 * 整體模型控制類
* Created  by wdd on 2019/10/16
*
**/
@RestController
@RequestMapping(value = "/genTable")
@Api(value="整體模型控制類",tags = "整體模型控制類",description = "整體模型控制類描述")
public class GenTableController { 
    @Resource
    private GenTableService genTableService;
    /**
     * 模型總表信息
     * @param page
     * @param limit
     * @return
     */
    @RequestMapping(value = "/model_list" , method = RequestMethod.GET)
    @ApiOperation(value="模型總表信息",notes="模型總表信息,分頁查詢",response=String.class)
    @ApiImplicitParams({
            @ApiImplicitParam(name = "page", value = "分頁的起始頁", required = true, dataType = "String"),
            @ApiImplicitParam(name = "limit", value = "每頁顯示的數(shù)量", required = true, dataType = "String")
    })
    public String modellist( @RequestParam(value="page",defaultValue="1") String page, @RequestParam (value="limit",defaultValue="10") String limit) {
        Map<String, Object> rtnMap = new HashMap<String, Object>();
        rtnMap.put("code", 500);
          //當(dāng)前頁
        Integer currPage = Integer.parseInt(page.trim());
        //每頁的數(shù)量
        Integer pageSize = Integer.parseInt(limit.trim());
        PageHelper.startPage(currPage, pageSize, true);
        List<GenTable> GenTableList = genTableService.selectGenTableList();
        PageInfo<GenTable> pageInfo=new PageInfo<>(GenTableList);
        if(!GenTableList.isEmpty()) {
            rtnMap.put("msg", "success");
            rtnMap.put("code", "0");
            rtnMap.put("data", GenTableList);
            rtnMap.put("count", pageInfo.getTotal());
        }else {
            rtnMap.put("msg", "error");
            rtnMap.put("code", "222222");
        }
        return JsonUtils.toJsonNoException(rtnMap);
    }
}

這樣呢就已經(jīng)配置好,下面是訪問效果 

訪問 原生的swagger 頁面 

http://127.0.0.1:666/swagger-ui.html,可以看到如下效果

訪問 swagger-bootstrap-ui 的頁面 

http://127.0.0.1:666/doc.html,可以看到如下效果 

swagger注解的詳細(xì)說明

   swagger2使用說明:
         @Api:用在類上,說明該類的作用
         @ApiOperation:用在方法上,說明方法的作用
         @ApiIgnore:使用該注解忽略這個(gè)API
         @ApiImplicitParams:用在方法上包含一組參數(shù)說明
         @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一個(gè)請求參數(shù)的各個(gè)方面
            paramType:參數(shù)放在哪個(gè)地方
                 header-->請求參數(shù)的獲?。篅RequestHeader
                 query-->請求參數(shù)的獲取:@RequestParam
                 path(用于restful接口)-->請求參數(shù)的獲?。篅PathVariable
                 body(不常用)
                 form(不常用)
             name:參數(shù)名
             dataType:參數(shù)類型
             required:參數(shù)是否必須傳
             value:參數(shù)的意思
             defaultValue:參數(shù)的默認(rèn)值
         @ApiResponses:用于表示一組響應(yīng)
         @ApiResponse:用在@ApiResponses中,一般用于表達(dá)一個(gè)錯(cuò)誤的響應(yīng)信息
             code:數(shù)字,例如400
             message:信息,例如"請求參數(shù)沒填好"
             response:拋出異常的類
         @ApiModel:描述一個(gè)Model的信息(這種一般用在post創(chuàng)建的時(shí)候,使用@RequestBody這樣的場景,請求參數(shù)無法使用@ApiImplicitParam注解進(jìn)行描述的時(shí)候)
            @ApiModelProperty:描述一個(gè)model的屬性

總結(jié)

以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。 

相關(guān)文章

  • 在Java中以及Spring環(huán)境下操作Redis的過程

    在Java中以及Spring環(huán)境下操作Redis的過程

    文章介紹了在Java和Spring環(huán)境下操作Redis的基本方法,在Java環(huán)境下,使用Maven創(chuàng)建項(xiàng)目并導(dǎo)入Jedis依賴,通過配置端口轉(zhuǎn)發(fā)訪問Redis,文章總結(jié)了Redis的基本命令和類別,如String、list、hash、set和zset,感興趣的朋友跟隨小編一起看看吧
    2025-03-03
  • java學(xué)習(xí)教程之常量折疊詳解

    java學(xué)習(xí)教程之常量折疊詳解

    這篇文章主要給大家介紹了關(guān)于java學(xué)習(xí)教程之常量折疊的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),對大家學(xué)習(xí)或者使用java具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2018-09-09
  • spring的13個(gè)經(jīng)典面試題

    spring的13個(gè)經(jīng)典面試題

    Spring框架是一個(gè)開放源代碼的J2EE應(yīng)用程序框架,是針對bean的生命周期進(jìn)行管理的輕量級容Spring解決了開發(fā)者在J2EE開發(fā)中遇到的許多常見的問題,我們這篇文章就來了解一下spring的面試題
    2021-06-06
  • Java Lambda表達(dá)式原理及多線程實(shí)現(xiàn)

    Java Lambda表達(dá)式原理及多線程實(shí)現(xiàn)

    這篇文章主要介紹了Java Lambda表達(dá)式原理及多線程實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2020-07-07
  • spring之Bean的生命周期詳解

    spring之Bean的生命周期詳解

    本篇文章主要介紹了spring之Bean的生命周期詳解,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧
    2017-05-05
  • Java +Tomcat + SpringMVC實(shí)現(xiàn)頁面訪問示例解析

    Java +Tomcat + SpringMVC實(shí)現(xiàn)頁面訪問示例解析

    這篇文章主要介紹了Java +Tomcat + SpringMVC實(shí)現(xiàn)頁面訪問示例解析,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2020-07-07
  • 在Java中讀取和解析JSON文件的示例代碼

    在Java中讀取和解析JSON文件的示例代碼

    我們在日常開發(fā)中少不了和JSON數(shù)據(jù)打交道,JSON是輕量、結(jié)構(gòu)化的數(shù)據(jù)交換格式,支持跨語言,本文給大家詳細(xì)介紹了如何在 Java 中讀取和解析 JSON 文件,并有詳細(xì)的代碼示例供大家參考,需要的朋友可以參考下
    2025-06-06
  • Java中的有限狀態(tài)機(jī)(設(shè)計(jì)模式——狀態(tài)模式)

    Java中的有限狀態(tài)機(jī)(設(shè)計(jì)模式——狀態(tài)模式)

    這篇文章主要介紹了Java中的有限狀態(tài)機(jī)(設(shè)計(jì)模式——狀態(tài)模式),具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2023-08-08
  • 一文詳細(xì)講解Java中有哪些鎖

    一文詳細(xì)講解Java中有哪些鎖

    在Java編程中鎖是一種同步機(jī)制,用于確保多個(gè)線程在訪問共享資源時(shí)的一致性和正確性,這篇文章主要介紹了Java中有哪些鎖的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下
    2025-07-07
  • 教你怎么在IDEA中創(chuàng)建java多模塊項(xiàng)目

    教你怎么在IDEA中創(chuàng)建java多模塊項(xiàng)目

    這篇文章主要介紹了教你怎么在IDEA中創(chuàng)建java多模塊項(xiàng)目,文中有非常詳細(xì)的代碼示例,對正在學(xué)習(xí)java的小伙伴們有非常好的幫助,需要的朋友可以參考下
    2021-04-04

最新評論

孝昌县| 德令哈市| 栾川县| 清丰县| 利辛县| 长顺县| 林州市| 包头市| 沂源县| 阳信县| 东安县| 丹凤县| 平利县| 聂拉木县| 泉州市| 孝感市| 梓潼县| 启东市| 汉中市| 金昌市| 芜湖县| 丰原市| 宁德市| 怀化市| 巴南区| 泰兴市| 梁山县| 平利县| 南岸区| 辛集市| 共和县| 三江| 北碚区| 迁安市| 碌曲县| 宁陕县| 潼南县| 平顺县| 济宁市| 普陀区| 利津县|