springboot中使用swagger

Apollo 發布于2019-08-16 16:41 / 852人閱讀

摘要：在做項目的時候對于的規范特別重要以前用了感覺挺好用但是就是有點麻煩現在中可以使用注解的方式來逆向生成文檔以下是使用步驟在文件中引入依賴在項目的配置文件中添加一個文件夾里面添加一個配置類用來描述哪些包下面會被掃描變成文檔網頁文檔網頁文檔

在做項目的時候對于api的規范特別重要,以前用了swagger,感覺挺好用,但是就是有點麻煩,現在springboot中可以使用注解的方式來逆向生成swagger文檔,以下是使用步驟:
1.在pom文件中引入依賴

    
        io.springfox
        springfox-swagger2
    
    
        io.springfox
        springfox-swagger-ui

2.在項目的配置文件中添加一個config文件夾,里面添加一個配置類,用來描述哪些包下面會被掃描變成swagger
文檔
@Configuration
@EnableSwagger2
public class Swagger2Configuration {

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.manage"))
            .paths(PathSelectors.any())
            .build();
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("網頁api文檔")
            .description("網頁api文檔")

// .termsOfServiceUrl("/")

            .version("1.0")
            .build();
}

}
在Java類中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下：
@Api：修飾整個類，描述Controller的作用
@ApiOperation：描述一個類的一個方法，或者說一個接口
@ApiParam：單個參數描述
@ApiModel：用對象來接收參數
@ApiModelProperty：用對象接收參數時，描述對象的一個字段
@ApiResponse：HTTP響應其中1個描述
@ApiResponses：HTTP響應整體描述
@ApiIgnore：使用該注解忽略這個API
@ApiError ：發生錯誤返回的信息
@ApiImplicitParam：一個請求參數
@ApiImplicitParams：多個請求參數
@ApiImplicitParam屬性：
例子:
//首先在接口上面描述接口的作用,詳情和參數
@Api(value="頁面管理接口",description = "頁面管理接口，提供頁面的增、刪、改、查")
public interface PageControllerApi {
@ApiOperation("分頁查詢頁面列表")
@ApiImplicitParams({
@ApiImplicitParam(name="page",value = "頁
碼",required=true,paramType="path",dataType="int"),
@ApiImplicitParam(name="size",value = "每頁記錄
數",required=true,paramType="path",dataType="int")
})
public QueryResponseResult findList(int page, int size) ;
}

//使用@ApiModelProperty描述模型類的各個字段
@Data
public class QueryPageRequest {

//接受頁面的條件參數
//站點id
@ApiModelProperty("頁面id")
String pageId;

}

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

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

新手上路-搭建項目-springboot-swagger2

摘要：新手上路搭建項目是一個接口文檔軟件界面如下添加這里使用版本可以正常使用配置文件測試新手上路。新手上路-搭建項目-springboot-swagger2 swagger2 是一個接口文檔軟件界面如下 showImg(https://segmentfault.com/img/bVOoim); gradle添加 compile(io.springfox:springfox-swagger...

XGBCCC 2019-08-14 18:38 評論0 收藏0
SpringBoot非官方教程 | 第十一篇：SpringBoot集成swagger2，構建優雅的R

摘要：另外很容易構建風格的，簡單優雅帥氣，正如它的名字。配置一些基本的信息。三寫生產文檔的注解通過注解表明該接口會生成文檔，包括接口名請求方法參數返回信息的等等。四參考資料中使用構建強大的文檔 swagger,中文拽的意思。它是一個功能強大的api框架，它的集成非常簡單，不僅提供了在線文檔的查閱，而且還提供了在線文檔的測試。另外swagger很容易構建restful風格的api，簡單優雅帥氣...

荊兆峰 2019-08-16 10:44 評論0 收藏0
SpringBoot 實戰 (五) | 集成 Swagger2 構建強大的 RESTful API

摘要：今天給你們帶來集成的教程。接口返回結果不明確。這些痛點在前后端分離的大型項目上顯得尤為煩躁。接口返回結果非常明確，包括數據類型，狀態碼，錯誤信息等。生成后的文件依賴如下這里使用的是的版本。另外，關注之后在發送可領取免費學習資料。微信公眾號：一個優秀的廢人如有問題或建議，請后臺留言，我會盡力解決你的問題。前言快過年了，不知道你們啥時候放年假，忙不忙。反正我是挺閑的，所以有時間寫 b...

Rindia 2019-08-16 15:12 評論0 收藏0