欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

Swagger使用和注釋詳解

 更新時間:2024年05月07日 10:10:27   作者:暴怒的代碼  
Swagger是一個規(guī)范和完整的框架,用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù),這篇文章主要介紹了Swagger使用和注釋介紹,需要的朋友可以參考下

一:介紹

1、什么是Swagger

Swagger是一個規(guī)范和完整的框架,用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù)??傮w目標是使客戶端和文件系統(tǒng)作為服務(wù)器以同樣的速度來更新。文件的方法,參數(shù)和模型緊密集成到服務(wù)器端的代碼,允許API來始終保持同步。

作用

  • 接口文檔在線自動生成
  • 功能測試

Swagger是一組開源項目,其中主要要項目如下:

  • Swagger-tools:提供各種與Swagger進行集成和交互的工具。例如模式檢驗、Swagger 1.2文檔轉(zhuǎn)換成Swagger 2.0文檔等功能。
  • Swagger-core: 用于Java/Scala的的Swagger實現(xiàn)。與JAX-RS(Jersey、Resteasy、CXF...)、Servlets和Play框架進行集成。
  • Swagger-js: 用于JavaScript的Swagger實現(xiàn)。
  • Swagger-node-express: Swagger模塊,用于node.js的Express web應(yīng)用框架。
  • Swagger-ui:一個無依賴的HTML、JS和CSS集合,可以為Swagger兼容API動態(tài)生成優(yōu)雅文檔。
  • Swagger-codegen:一個模板驅(qū)動引擎,通過分析用戶Swagger資源聲明以各種語言生成客戶端代碼。

2、在Spring使用Swagger

在Spring中集成Swagger會使用到springfox-swagger,它對Spring和Swagger的使用進行了整合

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${springfox.swagger.version}</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${springfox.swagger.version}</version>
</dependency>

二:使用

1、Spring中配置Swagger

/**
 * Swagger2配置類
 * 在與spring boot集成時,放在與Application.java同級的目錄下。
 * 或者通過 @Import 導(dǎo)入配置
 */
@Configuration
@EnableSwagger2
public class Swagger2 {
    /**
     * 創(chuàng)建API應(yīng)用
     * apiInfo() 增加API相關(guān)信息
     * 通過select()函數(shù)返回一個ApiSelectorBuilder實例,用來控制哪些接口暴露給Swagger來展現(xiàn),
     * 本例采用指定掃描的包路徑來定義指定要建立API的目錄。
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.turbo.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    /**
     * 創(chuàng)建該API的基本信息(這些基本信息會展現(xiàn)在文檔頁面中)
     * 訪問地址:http://項目實際地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2構(gòu)建RESTful APIs")
                .description("")
                .termsOfServiceUrl("")
                .contact("zou", "", "zouxq412@foxmail.com")
                .version("1.0")
                .build();
    }
}

2、API注解 @Api

用在類上,該注解將一個Controller(Class)標注為一個swagger資源(API)。在默認情況下,Swagger-Core只會掃描解析具有@Api注解的類,而會自動忽略其他類別資源(JAX-RS endpoints,Servlets等等)的注解。該注解包含以下幾個重要屬性

  • tags API分組標簽。具有相同標簽的API將會被歸并在一組內(nèi)展示。
  • value 如果tags沒有定義,value將作為Api的tags使用
  • description API的詳細描述,在1.5.X版本之后不再使用,但實際發(fā)現(xiàn)在2.0.0版本中仍然可以使用

在指定的(路由)路徑上,對一個操作或HTTP方法進行描述。具有相同路徑的不同操作會被歸組為同一個操作對象。不同的HTTP請求方法及路徑組合構(gòu)成一個唯一操作。此注解的屬性有:

  • value 對操作的簡單說明,長度為120個字母,60個漢字。
  • notes 對操作的詳細說明。
  • httpMethod HTTP請求的動作名,可選值有:"GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH"。
  • code 默認為200,有效值必須符合標準的HTTP Status Code Definitions。

@ApiImplicitParams

用在方法上,注解ApiImplicitParam的容器類,以數(shù)組方式存儲。

@ApiImplicitParam

對API的單一參數(shù)進行注解。雖然注解@ApiParam同JAX-RS參數(shù)相綁定,但這個@ApiImplicitParam注解可以以統(tǒng)一的方式定義參數(shù)列表,也是在Servelet及非JAX-RS環(huán)境下,唯一的方式參數(shù)定義方式。注意這個注解@ApiImplicitParam必須被包含在注解@ApiImplicitParams之內(nèi)??梢栽O(shè)置以下重要參數(shù)屬性:

  • name 參數(shù)名稱
  • value 參數(shù)的簡短描述
  • required 是否為必傳參數(shù)
  • dataType 參數(shù)類型,可以為類名,也可以為基本類型(String,int、boolean等)
  • paramType 參數(shù)的傳入(請求)類型,可選的值有path, query, body, header or form。

@ApiParam

增加對參數(shù)的元信息說明。這個注解只能被使用在JAX-RS 1.x/2.x的綜合環(huán)境下。其主要的屬性有

  • required 是否為必傳參數(shù),默認為false
  • value 參數(shù)簡短說明

@ApiResponses

注解@ApiResponse的包裝類,數(shù)組結(jié)構(gòu)。即使需要使用一個@ApiResponse注解,也需要將@ApiResponse注解包含在注解@ApiResponses內(nèi)。

@ApiResponse

描述一個操作可能的返回結(jié)果。當REST API請求發(fā)生時,這個注解可用于描述所有可能的成功與錯誤碼。可以用,也可以不用這個注解去描述操作的返回類型,但成功操作的返回類型必須在@ApiOperation中定義。如果API具有不同的返回類型,那么需要分別定義返回值,并將返回類型進行關(guān)聯(lián)。但Swagger不支持同一返回碼,多種返回類型的注解。注意:這個注解必須被包含在@ApiResponses注解中。

  • code HTTP請求返回碼。有效值必須符合標準的HTTP Status Code Definitions。
  • message 更加易于理解的文本消息
  • response 返回類型信息,必須使用完全限定類名,比如“com.xyz.cc.Person.class”。
  • responseContainer 如果返回類型為容器類型,可以設(shè)置相應(yīng)的值。有效值為 "List", "Set" or "Map",其他任何無效的值都會被忽略。

3、Model注解

對于Model的注解,Swagger提供了兩個:@ApiModel及@ApiModelProperty,分別用以描述Model及Model內(nèi)的屬性。

@ApiModel

描述一個Model的信息(一般用在請求參數(shù)無法使用@ApiImplicitParam注解進行描述的時候)

提供對Swagger model額外信息的描述。在標注@ApiOperation注解的操作內(nèi),所有的類將自動被內(nèi)省(introspected),但利用這個注解可以做一些更加詳細的model結(jié)構(gòu)說明。主要屬性有:

  • value model的別名,默認為類名
  • description model的詳細描述

@ApiModelProperty

描述一個model的屬性

對model屬性的注解,主要的屬性值有:

  • value 屬性簡短描述
  • example 屬性的示例值
  • required 是否為必須值

4、注解示例

Api 示例

@AllArgsConstructor
@RestController
@RequestMapping("/api/category")
@Api(value = "/category", tags = "組件分類")
public class BizCategoryController {
    private IBizCategoryService bizCategoryService;
    @GetMapping("/list")
    @ApiOperation(value = "列表", notes = "分頁列表")
    public R<PageModel<BizCategory>> list(PageQuery pageQuery,
                                          @RequestParam @ApiParam("組件分類名稱") String name) {
        IPage<BizCategory> page = bizCategoryService.page(pageQuery.loadPage(),
                new LambdaQueryWrapper<BizCategory>().like(BizCategory::getName, name));
        return R.success(page);
    }
    @GetMapping("/list/all")
    @ApiOperation(value = "查詢所有", notes = "分頁列表")
    public R<List<BizCategory>> listAll() {
        List<BizCategory> categories = bizCategoryService.list();
        return R.success(categories);
    }
    @GetMapping("/{categoryId}")
    @ApiOperation(value = "詳情", notes = "組件分類詳情")
    public R<BizCategory> detail(@PathVariable @ApiParam("分類Id") Long categoryId) {
        BizCategory category = bizCategoryService.getById(categoryId);
        return R.success(category);
    }
    @PostMapping("/save")
    @ApiOperation(value = "保存", notes = "新增或修改")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "form", name = "categoryId", value = "組件id(修改時為必填)"),
            @ApiImplicitParam(paramType = "form", name = "name", value = "組件分類名稱", required = true)
    })
    public R<BizCategory> save(Long categoryId, String name) {
        BizCategory category = new BizCategory();
        category.setId(categoryId);
        category.setName(name);
        bizCategoryService.saveOrUpdate(category);
        return R.success(category);
    }
    @DeleteMapping("/{categoryId}")
    @ApiOperation(value = "刪除", notes = "刪除")
    public R delete(@PathVariable @ApiParam("分類Id") Long categoryId) {
        bizCategoryService.delete(categoryId);
        return R.success();
    }
}

ApiModel 示例

@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@ApiModel(value="BizComponent對象", description="組件")
public class BizComponent implements Serializable {
    private static final long serialVersionUID = 1L;
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;
    @ApiModelProperty(value = "分類")
    private Long categoryId;
    @ApiModelProperty(value = "組件名稱")
    private String name;
    @ApiModelProperty(value = "組件描述")
    private String description;
    @ApiModelProperty(value = "日期字段")
    private LocalDateTime componentTime;
    @ApiModelProperty(value = "創(chuàng)建時間")
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;
    @ApiModelProperty(value = "修改時間")
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime modifiedTime;
}

三:swagger-ui界面

swagger生成的api文檔信息接口為/v2/api-docs,不過我們可以使用ui界面更加清晰的查看文檔說明,并且還能夠在線調(diào)試

1、springfox-swagger-ui

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${springfox.swagger.version}</version>
</dependency>

如果是使用springfox-swagger-ui,啟動項目后的api文檔訪問路徑是 /swagger-ui.html

2、swagger-bootstrap-ui

swagger-bootstrap-ui是springfox-swagger的增強UI實現(xiàn),我個人更推薦使用這個ui,api文檔結(jié)構(gòu)更加清晰,在線調(diào)試也很方便

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>${swagger.bootstrap.ui.version}</version>
</dependency>

訪問的url為 /doc.html

四:Swagger分組

Swagger的分組接口是通過后端配置不同的掃描包,將后端的接口,按配置的掃描包基礎(chǔ)屬性響應(yīng)給前端

后端java的配置如下,指定分組名和各自要掃描的包

@Bean(value = "defaultApi")
public Docket defaultApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .groupName("默認接口")
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
        .paths(PathSelectors.any())
        .build();
}
@Bean(value = "groupApi")
public Docket groupRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(groupApiInfo())
        .groupName("分組接口")
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.example.demo.group"))
        .paths(PathSelectors.any())
        .build();
}

分組信息的接口為 /swagger-resources

[
    {
        "name": "分組接口",
        "url": "/v2/api-docs?group=分組接口",
        "swaggerVersion": "2.0",
        "location": "/v2/api-docs?group=分組接口"
    },{
        "name": "默認接口",
        "url": "/v2/api-docs?group=默認接口",
        "swaggerVersion": "2.0",
        "location": "/v2/api-docs?group=默認接口"
    }
]

在swagger-ui中也可以通過分組來查看api文檔

到此這篇關(guān)于Swagger使用和注釋介紹的文章就介紹到這了,更多相關(guān)Swagger使用和注釋內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • Java配置DBeaver的詳細步驟

    Java配置DBeaver的詳細步驟

    DBeaver是一個集成的數(shù)據(jù)庫客戶端工具,需要java語言支持,所以安裝之前需要配置JDK環(huán)境,這篇文章主要介紹了Java配置DBeaver的詳細步驟,需要的朋友可以參考下
    2021-03-03
  • 淺談springboot多模塊(modules)開發(fā)

    淺談springboot多模塊(modules)開發(fā)

    這篇文章主要介紹了淺談springboot多模塊(modules)開發(fā),詳細的介紹了springboot多模塊的實現(xiàn),有興趣的可以了解一下
    2017-09-09
  • springboot 單文件上傳的實現(xiàn)步驟

    springboot 單文件上傳的實現(xiàn)步驟

    這篇文章主要介紹了springboot實現(xiàn)單文件上傳的方法,幫助大家更好的理解和使用springboot框架,感興趣的朋友可以了解下
    2021-02-02
  • 解決weblogic部署springboot項目步驟及可能會出現(xiàn)的問題

    解決weblogic部署springboot項目步驟及可能會出現(xiàn)的問題

    這篇文章主要介紹了解決weblogic部署springboot項目步驟及可能會出現(xiàn)的問題,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教
    2021-07-07
  • Java實現(xiàn)FIFO、LRU、LFU、OPT頁面置換算法

    Java實現(xiàn)FIFO、LRU、LFU、OPT頁面置換算法

    本文主要介紹了Java實現(xiàn)FIFO、LRU、LFU、OPT頁面置換算法,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2023-02-02
  • java實現(xiàn)新浪微博Oauth接口發(fā)送圖片和文字的方法

    java實現(xiàn)新浪微博Oauth接口發(fā)送圖片和文字的方法

    這篇文章主要介紹了java實現(xiàn)新浪微博Oauth接口發(fā)送圖片和文字的方法,涉及java調(diào)用新浪微博Oauth接口的使用技巧,具有一定參考接借鑒價值,需要的朋友可以參考下
    2015-07-07
  • 在Spring?Boot中啟用HTTPS的方法

    在Spring?Boot中啟用HTTPS的方法

    本文介紹了在Spring Boot項目中啟用HTTPS的步驟,從生成SSL證書開始,到配置Spring Boot。HTTPS是保護Web應(yīng)用程序安全的基石之一,而Spring Boot則提供了相對簡易的途徑來配置它,感興趣的朋友跟隨小編一起看看吧
    2024-02-02
  • 解決static類使用@Value獲取yml文件獲取不到的問題

    解決static類使用@Value獲取yml文件獲取不到的問題

    在靜態(tài)類中直接使用@Value注解無法獲取yml文件中的配置,解決方案是在工具類Utils中創(chuàng)建靜態(tài)的setter方法,并從外部類ServiceClass中調(diào)用這個方法來設(shè)置值,這種方法通過外部調(diào)用來間接設(shè)置靜態(tài)變量的值,從而成功讀取yml配置
    2024-09-09
  • Spring 依賴注入的幾種方式詳解

    Spring 依賴注入的幾種方式詳解

    本篇文章主要介紹了Spring 依賴注入的幾種方式詳解,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧
    2017-02-02
  • 美化java代碼,從合理注釋開始

    美化java代碼,從合理注釋開始

    在Java的編寫過程中我們需要對一些程序進行注釋,除了自己方便閱讀,更為別人更好理解自己的程序,可以是編程思路或者是程序的作用,總而言之就是方便自己他人更好的閱讀。下面我們來一起學(xué)習(xí)一下吧
    2019-06-06

最新評論