資訊專(zhuān)欄INFORMATION COLUMN
摘要：簡(jiǎn)介簡(jiǎn)單的來(lái)說(shuō)，的誕生就是為了解決前后端開(kāi)發(fā)人員進(jìn)行交流的時(shí)候文檔難以維護(hù)的痛點(diǎn)，它可以和我們的程序完美的結(jié)合在一起，并且可以與我們的另一開(kāi)發(fā)利器來(lái)配合使用。
Swagger2簡(jiǎn)介
簡(jiǎn)單的來(lái)說(shuō)，Swagger2的誕生就是為了解決前后端開(kāi)發(fā)人員進(jìn)行交流的時(shí)候API文檔難以維護(hù)的痛點(diǎn)，它可以和我們的Java程序完美的結(jié)合在一起，并且可以與我們的另一開(kāi)發(fā)利器Spring Boot來(lái)配合使用。
開(kāi)始使用 第一步：導(dǎo)入POM文件io.springfox springfox-swagger2 2.9.2 com.github.xiaoymin swagger-bootstrap-ui 1.9.0
#### 第二步：添加配置類(lèi)
我們需要新增一個(gè)Swagger2Config 的配置類(lèi)：
/**
* Swagger2 配置類(lèi)
* @author vi
* @since 2019/3/6 8:31 PM
*/
@Configuration
public class Swagger2Config {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("indi.viyoung.viboot.*"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("viboot-swagger2") //標(biāo)題
.description("Restful-API-Doc") //描述
.termsOfServiceUrl("https://www.cnblogs.com/viyoung") //這里配置的是服務(wù)網(wǎng)站，我寫(xiě)的是我的博客園站點(diǎn)~歡迎關(guān)注~
.contact(new Contact("Vi的技術(shù)博客", "https://www.cnblogs.com/viyoung", "18530069930@163.com")) // 三個(gè)參數(shù)依次是姓名，個(gè)人網(wǎng)站，郵箱
.version("1.0") //版本
.build();
}
}
第三步：在啟動(dòng)類(lèi)中添加配置
注意一定要記得添加@EnableSwagger2注解
/**
* @author vi
* @since 2019/3/6 6:35 PM
*/
@SpringBootApplication
@ComponentScan(value = "indi.viyoung.viboot.*")
@MapperScan(value = "indi.viyoung.viboot.swagger2.mapper")
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class ViBootSwaggerApplication {
public static void main(String[] args) {
SpringApplication.run(ViBootSwaggerApplication.class, args);
}
}
第四步：通過(guò)注解來(lái)完成API文檔
| 注解名稱 | 注解屬性 | 作用域 | 屬性作用 |
|---|---|---|---|
| @Api | tags | 類(lèi) | 說(shuō)明該類(lèi)的作用 |
| value | 類(lèi) | 說(shuō)明該類(lèi)的作用 |
舉個(gè)
文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址：http://m.specialneedsforspecialkids.com/yun/75909.html
摘要：再通過(guò)函數(shù)創(chuàng)建的之后，用來(lái)創(chuàng)建該的基本信息這些基本信息會(huì)展現(xiàn)在文檔頁(yè)面中。函數(shù)返回一個(gè)實(shí)例用來(lái)控制哪些接口暴露給來(lái)展現(xiàn)，本例采用指定掃描的包路徑來(lái)定義，會(huì)掃描該包下所有定義的，并產(chǎn)生文檔內(nèi)容除了被指定的請(qǐng)求。 showImg(http://download.qfeoo.com/kotlin_springboot_logo.png); 這里有個(gè)地方需要注意，在測(cè)試WebFlux集成Swa...
摘要：集成生成接口文檔原文簡(jiǎn)介由于的特性，用來(lái)開(kāi)發(fā)變得非常容易，并且結(jié)合來(lái)自動(dòng)生成文檔變得方便快捷。使用生成，我們可以得到交互式文檔。聽(tīng)過(guò)與的結(jié)合，生成更加完備的文檔。接下來(lái)將基于與搭建完整的文檔系統(tǒng)。 Spring Boot Swagger2 集成REST ful API 生成接口文檔 原文 簡(jiǎn)介 由于Spring Boot 的特性，用來(lái)開(kāi)發(fā) REST ful 變得非常容易，并且結(jié)合 Sw...
摘要：沒(méi)錯(cuò)，不支持，從導(dǎo)出的文檔也可以看到，部分中文無(wú)法顯示，目前我也尚未找到是否有配置可以實(shí)現(xiàn)這個(gè)功能。相對(duì)前面的方式，使用起來(lái)更加簡(jiǎn)單，也可以修改配置輸出中文。 更多精彩博文，歡迎訪問(wèn)我的個(gè)人博客 說(shuō)明 我個(gè)人是一直使用Swagger作為接口文檔的說(shuō)明的。但是由于在一些情況下，接口文檔說(shuō)明需要以文件的形式交付出去，如果再重新寫(xiě)一份文檔難免有些麻煩。于是在網(wǎng)上看到了Swagger2Mar...
摘要：使用生成，我們可以得到交互式文檔，自動(dòng)生成代碼的以及的發(fā)現(xiàn)特性等。方法指定掃描的包會(huì)生成文檔默認(rèn)是顯示所有接口可以用注解標(biāo)識(shí)該接口不顯示。 程序員都很希望別人能寫(xiě)技術(shù)文檔，自己卻很不愿意寫(xiě)文檔。因?yàn)榻涌跀?shù)量繁多,并且充滿業(yè)務(wù)細(xì)節(jié),寫(xiě)文檔需要花大量的時(shí)間去處理格式排版,代碼修改后還需要同步修改文檔,經(jīng)常因?yàn)轫?xiàng)目時(shí)間緊等原因?qū)е挛臋n滯后于代碼，接口調(diào)用方的抱怨聲不絕于耳。而程序員是最擅長(zhǎng)偷...
摘要：今天給你們帶來(lái)集成的教程。接口返回結(jié)果不明確。這些痛點(diǎn)在前后端分離的大型項(xiàng)目上顯得尤為煩躁。接口返回結(jié)果非常明確，包括數(shù)據(jù)類(lèi)型，狀態(tài)碼，錯(cuò)誤信息等。生成后的文件依賴如下這里使用的是的版本。另外，關(guān)注之后在發(fā)送可領(lǐng)取免費(fèi)學(xué)習(xí)資料。 微信公眾號(hào)：一個(gè)優(yōu)秀的廢人如有問(wèn)題或建議，請(qǐng)后臺(tái)留言，我會(huì)盡力解決你的問(wèn)題。 前言 快過(guò)年了，不知道你們啥時(shí)候放年假，忙不忙。反正我是挺閑的，所以有時(shí)間寫(xiě) b...
閱讀 917·2021-09-29 09:35
閱讀 1261·2021-09-28 09:36
閱讀 1532·2021-09-24 10:38
閱讀 1079·2021-09-10 11:18
閱讀 640·2019-08-30 15:54
閱讀 2508·2019-08-30 13:22
閱讀 1973·2019-08-30 11:14
閱讀 708·2019-08-29 12:35
