[Spring Boot + Swagger]后端并不想與你說話并向你扔出一個(gè)接口文檔鏈接

dreamans 發(fā)布于2019-08-15 12:20 / 1404人閱讀

摘要：背景最近在做一個(gè)的項(xiàng)目，接口寫的差不多了，后續(xù)大概要和前端對(duì)接。眾所周知后端和前端的溝通是非常耗時(shí)和費(fèi)力的，這時(shí)候有一個(gè)完善的接口文檔會(huì)帶來很大的幫助。就是一個(gè)非常好的選擇。結(jié)果啟動(dòng)應(yīng)用，訪問查看接口文檔。

背景

最近在做一個(gè)Spring Boot的項(xiàng)目，接口寫的差不多了，后續(xù)大概要和前端對(duì)接。眾所周知后端和前端的溝通是非常耗時(shí)和費(fèi)力的，這時(shí)候有一個(gè)完善的接口文檔會(huì)帶來很大的幫助。Swagger就是一個(gè)非常好的選擇。

添加依賴

Gradle工程添加如下依賴：

    compile("io.springfox:springfox-swagger-ui:2.6.1")
    compile("io.springfox:springfox-swagger2:2.6.1")

Maven工程添加如下依賴：


    io.springfox
    springfox-swagger-ui
    2.6.1
    compile


    io.springfox
    springfox-swagger2
    2.6.1
    compile

——————

修改代碼

為Applicaion類添加Swagger的注解：

@SpringBootApplication
@EnableSwagger2
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

創(chuàng)建一個(gè)配置類，防止將Spring默認(rèn)的錯(cuò)誤處理等接口放入文檔中。

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2).select()
                .apis(Predicates.not(RequestHandlerSelectors.basePackage("org.springframework.boot")))
                .build();
    }
}

結(jié)果

啟動(dòng)應(yīng)用，訪問"/swagger-ui.html",查看接口文檔。

甚至可以直接測(cè)試接口。

感想

還是要善于使用各種開發(fā)工具。

GPU云服務(wù)器云服務(wù)器 swagger+spring Spring Boot spring boot webrtc spring boot微服務(wù)

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://systransis.cn/yun/67883.html

相關(guān)文章

實(shí)踐是檢驗(yàn)程序員的唯一標(biāo)準(zhǔn)01：用戶不想跟你說話并向你扔出一張圖片 - 圖片上傳組件開發(fā)【思路篇】

摘要：表示不一定是原生形式的數(shù)據(jù)。接口基于，繼承了的功能并將其擴(kuò)展使其支持用戶系統(tǒng)上的文件。讀取操作完成的時(shí)候，會(huì)變成已完成，并觸發(fā)事件，同時(shí)屬性將包含一個(gè)格式的字符串編碼以表示所讀取文件的內(nèi)容。溫馨提示：這里除了一些幼稚的小組件啥也沒有溫馨提示-續(xù)：這是一個(gè)新的系列，寫一些實(shí)際開發(fā)中遇到的一些常用的功能，想法笨拙，代碼亂套寫在前面圖片上傳，作為web端一個(gè)常用的功能，在不同的項(xiàng)目中有...

PiscesYE 2019-08-26 11:31 評(píng)論0 收藏0
實(shí)踐是檢驗(yàn)程序員的唯一標(biāo)準(zhǔn)02：用戶不想跟你說話并向你扔出一張圖片 - 圖片上傳組件開發(fā)【開發(fā)篇】

摘要：溫馨提示這里除了一些幼稚的小組件啥也沒有寫在前面距離寫完上一篇實(shí)踐是檢驗(yàn)程序員的唯一標(biāo)準(zhǔn)用戶不想跟你說話并向你扔出一張圖片圖片上傳組件開發(fā)思路篇過去了大半年，才開始寫開發(fā)篇真的是令人悲哀，不過有句話說的好，開始做一件事最好的時(shí)間是大半年前溫馨提示：這里除了一些幼稚的小組件啥也沒有寫在前面距離寫完上一篇實(shí)踐是檢驗(yàn)程序員的唯一標(biāo)準(zhǔn)01：用戶不想跟你說話并向你扔出一張圖片 - 圖片上傳...

CocoaChina 2019-08-23 12:26 評(píng)論0 收藏0
一起來學(xué)SpringBoot | 第十一篇：集成Swagger在線調(diào)試

摘要：但是這種手寫文檔帶來的弊端就是維護(hù)起來苦不堪言，對(duì)于接口容易發(fā)生變化的開發(fā)者來說，維護(hù)文檔就是噩夢(mèng)好在現(xiàn)如今市場上書寫文檔的工具有很多，常見的有阿里的但是能稱之為框架的，估計(jì)也只有了。 SpringBoot 是為了簡化 Spring 應(yīng)用的創(chuàng)建、運(yùn)行、調(diào)試、部署等一系列問題而誕生的產(chǎn)物，自動(dòng)裝配的特性讓我們可以更好的關(guān)注業(yè)務(wù)本身而不是外部的XML配置，我們只需遵循規(guī)范，引入相關(guān)的依賴...

everfly 2019-08-16 12:35 評(píng)論0 收藏0
使用spring boot + swagger自動(dòng)生成HTML、PDF接口文檔，并解決中文顯示為空白

摘要：首先是從下載了，這個(gè)已經(jīng)能夠生成和文檔了，但是對(duì)中文支持不好，中文大部分會(huì)顯示為空白。關(guān)于這個(gè)對(duì)中文支持不好，查了很多資料，應(yīng)該是字體和主題的原因，所以參考了很多資料，結(jié)合當(dāng)前這個(gè)，做出了最終的能很好支持中文的，最終地址。做后端開發(fā)，自然離不開接口文檔，接口文檔不僅方便后端開發(fā)人員之間查看，更是前端人員必要的文檔，也有可能提供給第三方來調(diào)用我們的接口。但是，寫接口文檔太費(fèi)時(shí)間，而且如...

fjcgreat 2019-08-16 15:49 評(píng)論0 收藏0
Java | Spring Boot Swagger2 集成REST ful API 生成接口文檔

摘要：集成生成接口文檔原文簡介由于的特性，用來開發(fā)變得非常容易，并且結(jié)合來自動(dòng)生成文檔變得方便快捷。使用生成，我們可以得到交互式文檔。聽過與的結(jié)合，生成更加完備的文檔。接下來將基于與搭建完整的文檔系統(tǒng)。 Spring Boot Swagger2 集成REST ful API 生成接口文檔原文簡介由于Spring Boot 的特性，用來開發(fā) REST ful 變得非常容易，并且結(jié)合 Sw...

joyvw 2019-08-16 10:56 評(píng)論0 收藏0