真实的国产乱ⅩXXX66竹夫人,五月香六月婷婷激情综合,亚洲日本VA一区二区三区,亚洲精品一区二区三区麻豆

成都創(chuàng)新互聯(lián)網(wǎng)站制作重慶分公司

springmvc集成swagger2

swagger2有一個web前端ui界面,可以清楚的看到所有被swagger2掃描到的接口列表,源碼在github上:swagger-ui

成都創(chuàng)新互聯(lián)是一家朝氣蓬勃的網(wǎng)站建設公司。公司專注于為企業(yè)提供信息化建設解決方案。從事網(wǎng)站開發(fā),網(wǎng)站制作,網(wǎng)站設計,網(wǎng)站模板,微信公眾號開發(fā),軟件開發(fā),微信小程序,10多年建站對混凝土泵車等多個方面,擁有豐富的網(wǎng)站制作經(jīng)驗。

這個版本不是最新版,但是帶有搜索功能,這是在最新版里沒有的。

項目×××之后,解壓,把dist文件夾下的所有的東西放到項目中靜態(tài)目錄下,目錄文件夾名稱假設是swagger,修改index.html文件里的js代碼,源碼里的js訪問doc路徑修改成自己項目的訪問路徑:
url = "/xxx/v2/api-docs";
xxx的部分就是web項目名稱,根據(jù)實際情況修改

這個v2/api-docs路徑是swagger2接口文檔的json數(shù)據(jù)訪問地址,這個地址返回的項目中所有接口說明的json格式字符串,這個index.html中的js代碼就解析這個json數(shù)據(jù)再渲染出來

項目需要依賴兩個包:

 
    io.springfox
    springfox-swagger2
    ${swagger2.version}


    io.springfox
    springfox-swagger-ui
    ${swagger-ui.version}


2.7.0
2.7.0

創(chuàng)建swagger2配置類:

@Configuration // 讓Spring來加載該類配置
@EnableSwagger2 // 啟用Swagger2
@EnableWebMvc
public class Swagger2Config {

    static final Logger log = LoggerFactory.getLogger(Swagger2Config.class);

    @Bean
    public Docket createRestApi() {
        log.info("開始加載Swagger2...");
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                                                      // 掃描指定包中的swagger注解
                                                      .apis(RequestHandlerSelectors.basePackage("com.xxx.xxx.controller"))
                                                      // 掃描所有有注解的api,用這種方式更靈活
                                                      // .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                                                      .paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("Api Documentation").description("xxx系統(tǒng)API接口文檔").version("1.0.0").build();
    }
}

到此配置文件,啟動項目,訪問地址:http://ip:port/項目名稱/swagger/index.html進入swagger-ui界面,進入后可以看到正在獲取數(shù)據(jù),那是解析數(shù)據(jù)的過程,稍等一會就會顯示出接口列表。

這個接口的json數(shù)據(jù)來源地址中的域名(也就是ip:port)這個部分是swagger2獲取的web項目啟動的tomcat的域名,有的環(huán)境下是會被nginx代理,真正的web服務器域名是不能直接訪問的,這個時候需要添加-Dspringfox.documentation.swagger.v2.host=xxx環(huán)境變量,配置nginx的域名,這樣就能正常經(jīng)過nginx走代理路徑。


網(wǎng)頁標題:springmvc集成swagger2
文章出自:http://weahome.cn/article/pspcsd.html

其他資訊

在線咨詢

微信咨詢

電話咨詢

028-86922220(工作日)

18980820575(7×24)

提交需求

返回頂部