国产xxxx99真实实拍_久久不雅视频_高清韩国a级特黄毛片_嗯老师别我我受不了了小说

資訊專欄INFORMATION COLUMN

SpringBoot整合Swagger2,再也不用維護接口文檔了!

ziwenxie / 731人閱讀

摘要:前后端分離后,維護接口文檔基本上是必不可少的工作。一個理想的狀態是設計好后,接口文檔發給前端和后端,大伙按照既定的規則各自開發,開發好了對接上了就可以上線了。本文主要和大伙來聊下在中如何整合。如此,就算配置成功了,非常方便。

前后端分離后,維護接口文檔基本上是必不可少的工作。一個理想的狀態是設計好后,接口文檔發給前端和后端,大伙按照既定的規則各自開發,開發好了對接上了就可以上線了。當然這是一種非常理想的狀態,實際開發中卻很少遇到這樣的情況,接口總是在不斷的變化之中,有變化就要去維護,做過的小伙伴都知道這件事有多么頭大!還好,有一些工具可以減輕我們的工作量,Swagger2就是其中之一,至于其他類似功能但是卻收費的軟件,這里就不做過多介紹了。本文主要和大伙來聊下在Spring Boot中如何整合Swagger2。

工程創建

當然,首先是創建一個Spring Boot項目,加入web依賴,創建成功后,加入兩個Swagger2相關的依賴,完整的依賴如下:


    io.springfox
    springfox-swagger2
    2.9.2


    io.springfox
    springfox-swagger-ui
    2.9.2


    org.springframework.boot
    spring-boot-starter-web
Swagger2配置

Swagger2的配置也是比較容易的,在項目創建成功之后,只需要開發者自己提供一個Docket的Bean即可,如下:

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.nvn.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("SpringBoot整合Swagger")
                        .description("SpringBoot整合Swagger,詳細信息......")
                        .version("9.0")
                        .contact(new Contact("啊啊啊啊","blog.csdn.net","aaa@gmail.com"))
                        .license("The Apache License")
                        .licenseUrl("http://www.baidu.com")
                        .build());
    }
}

這里提供一個配置類,首先通過@EnableSwagger2注解啟用Swagger2,然后配置一個Docket Bean,這個Bean中,配置映射路徑和要掃描的接口的位置,在apiInfo中,主要配置一下Swagger2文檔網站的信息,例如網站的title,網站的描述,聯系人的信息,使用的協議等等。

如此,Swagger2就算配置成功了,非常方便。

此時啟動項目,輸入http://localhost:8080/swagger-ui.html,能夠看到如下頁面,說明已經配置成功了:

創建接口

接下來就是創建接口了,Swagger2相關的注解其實并不多,而且很容易懂,下面我來分別向小伙伴們舉例說明:

@RestController
@Api(tags = "用戶管理相關接口")
@RequestMapping("/user")
public class UserController {

    @PostMapping("/")
    @ApiOperation("添加用戶的接口")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "username", value = "用戶名", defaultValue = "李四"),
            @ApiImplicitParam(name = "address", value = "用戶地址", defaultValue = "深圳", required = true)
    }
    )
    public RespBean addUser(String username, @RequestParam(required = true) String address) {
        return new RespBean();
    }

    @GetMapping("/")
    @ApiOperation("根據id查詢用戶的接口")
    @ApiImplicitParam(name = "id", value = "用戶id", defaultValue = "99", required = true)
    public User getUserById(@PathVariable Integer id) {
        User user = new User();
        user.setId(id);
        return user;
    }
    @PutMapping("/{id}")
    @ApiOperation("根據id更新用戶的接口")
    public User updateUserById(@RequestBody User user) {
        return user;
    }
}

這里邊涉及到多個API,我來向小伙伴們分別說明:

@Api注解可以用來標記當前Controller的功能。

@ApiOperation注解用來標記一個方法的作用。

@ApiImplicitParam注解用來描述一個參數,可以配置參數的中文含義,也可以給參數設置默認值,這樣在接口測試的時候可以避免手動輸入。

如果有多個參數,則需要使用多個@ApiImplicitParam注解來描述,多個@ApiImplicitParam注解需要放在一個@ApiImplicitParams注解中。

需要注意的是,@ApiImplicitParam注解中雖然可以指定參數是必填的,但是卻不能代替@RequestParam(required = true),前者的必填只是在Swagger2框架內必填,拋棄了Swagger2,這個限制就沒用了,所以假如開發者需要指定一個參數必填,@RequestParam(required = true)注解還是不能省略。

如果參數是一個對象(例如上文的更新接口),對于參數的描述也可以放在實體類中。例如下面一段代碼:

@ApiModel
public class User {
    @ApiModelProperty(value = "用戶id")
    private Integer id;
    @ApiModelProperty(value = "用戶名")
    private String username;
    @ApiModelProperty(value = "用戶地址")
    private String address;
    //getter/setter
}

好了,經過如上配置之后,接下來,刷新剛剛打開的頁面,可以看到如下效果:

可以看到,所有的接口這里都列出來了,包括接口請求方式,接口地址以及接口的名字等,點開一個接口,可以看到如下信息:

可以看到,接口的參數,參數要求,參數默認值等等統統都展示出來了,參數類型下的query表示參數以key/value的形式傳遞,點擊右上角的Try it out,就可以進行接口測試:

點擊Execute按鈕,表示發送請求進行測試。測試結果會展示在下面的Response中。

小伙伴們注意,參數類型下面的query表示參數以key/value的形式傳遞,這里的值也可能是body,body表示參數以請求體的方式傳遞,例如上文的更新接口,如下:

當然還有一種可能就是這里的參數為path,表示參數放在路徑中傳遞,例如根據id查詢用戶的接口:

當然,除了這些之外,還有一些響應值的注解,都比較簡單,小伙伴可以自己摸索下。

在Security中的配置

如果我們的Spring Boot項目中集成了Spring Security,那么如果不做額外配置,Swagger2文檔可能會被攔截,此時只需要在Spring Security的配置類中重寫configure方法,添加如下過濾即可:

@Override
public void configure(WebSecurity web) throws Exception {
    web.ignoring()
            .antMatchers("/swagger-ui.html")
            .antMatchers("/v2/**")
            .antMatchers("/swagger-resources/**");
}

如此之后,Swagger2文件就不需要認證就能訪問了。不知道小伙伴們有沒有看懂呢?有問題歡迎留言討論。

關注公眾號【江南一點雨】,專注于 Spring Boot+微服務以及前后端分離等全棧技術,定期視頻教程分享,關注后回復 Java ,領取松哥為你精心準備的 Java 干貨!

文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。

轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/73887.html

相關文章

  • 兩年,我寫這些干貨!

    摘要:開公眾號差不多兩年了,有不少原創教程,當原創越來越多時,大家搜索起來就很不方便,因此做了一個索引幫助大家快速找到需要的文章系列處理登錄請求前后端分離一使用完美處理權限問題前后端分離二使用完美處理權限問題前后端分離三中密碼加鹽與中異常統一處理 開公眾號差不多兩年了,有不少原創教程,當原創越來越多時,大家搜索起來就很不方便,因此做了一個索引幫助大家快速找到需要的文章! Spring Boo...

    huayeluoliuhen 評論0 收藏0
  • SpringBoot 2.X Kotlin與Swagger2生成API文檔

    摘要:再通過函數創建的之后,用來創建該的基本信息這些基本信息會展現在文檔頁面中。函數返回一個實例用來控制哪些接口暴露給來展現,本例采用指定掃描的包路徑來定義,會掃描該包下所有定義的,并產生文檔內容除了被指定的請求。 showImg(http://download.qfeoo.com/kotlin_springboot_logo.png); 這里有個地方需要注意,在測試WebFlux集成Swa...

    cyqian 評論0 收藏0
  • 前后端分離時代,Java 程序員的變與不變!

    摘要:前后端分離的開發方式在最近幾年突然火起來,松哥認為有兩方面的原因前端的發展。不變其實除了前后端交互方式發生變化之外,其他的地方都是不變的。 事情的起因是這樣的,有個星球的小伙伴向邀請松哥在知乎上回答一個問題,原題是: 前后端分離的時代,Java后臺程序員的技術建議? 松哥認真看了下這個問題,感覺對于初次接觸前后端分離的小伙伴來說,可能都會存在這樣的疑問,于是決定通過這篇文章和大家聊一...

    SolomonXie 評論0 收藏0
  • ApiBoot - ApiBoot Swagger 使用文檔

    摘要:相關配置配置參數參數介紹默認值是否啟用文檔標題快速集成文檔文檔描述通過自動化配置快速集成文檔,僅需一個注解一個依賴即可。注意通過所獲取的類型都為。 ApiBoot是一款基于SpringBoot1.x,2.x的接口服務集成基礎框架, 內部提供了框架的封裝集成、使用擴展、自動化完成配置,讓接口開發者可以選著性完成開箱即用, 不再為搭建接口框架而犯愁,從而極大...

    yuanxin 評論0 收藏0

發表評論

0條評論

ziwenxie

|高級講師

TA的文章

閱讀更多
最新活動
閱讀需要支付1元查看
<