1. 程式人生 > >Springfox Swagger2(二):常用註解

Springfox Swagger2(二):常用註解

@ApiIgnore():用於類或者方法上,可以不被swagger顯示在頁面上 

@Api():用於類表示標識這個類是swagger的資源 

    tags–表示說明 但是tags如果有多個值,會生成多個list
    value–也是說明,可以使用tags替代 (實際沒有作用)

@ApiOperation():用於方法;表示一個http請求的操作 

    value用於方法描述 
    notes用於提示內容 
    tags可以重新分組(視情況而用)

@ApiImplicitParams()用於方法,包含多個 @ApiImplicitParam

    name–引數ming 

    value–引數說明 

    required 是否必須 boolean

    dataType–資料型別 

    paramType–引數型別 

        body 使用@RequestBody接收資料 POST有效
        path 在url中配置{}的引數
        query 普通查詢引數 例如 ?query=q ,jquery ajax中data設定的值也可以,例如 {query:”q”},springMVC中不需要添加註解接收
        header 使用@RequestHeader接收資料
        form 筆者未使用,請檢視官方API文件

    example–舉例說明

@ApiImplicitParam()

用於方法 表示單獨的請求引數 

    表示單獨的請求引數 

@ApiResponses()用於表示一組響應

@ApiResponse():用在@ApiResponses中,一般用於表達一個錯誤的響應資訊

    code:數字,例如400
  message:資訊,例如"請求引數沒填好"
  response:丟擲異常的類

@ApiParam()用於方法,引數,欄位說明;表示對引數的新增元資料(說明或是否必填等)

    name–引數名 
    value–引數說明 
    required–是否必填 

@ApiModel()用於類 表示對類進行說明,用於引數用實體類接收 

    value–表示物件名 
    description–描述 
    都可省略 

@ApiModelProperty():用於方法,欄位 表示對model屬性的說明或者資料操作更改 

    value–欄位說明 
    required–是否必填 
    name–重寫屬性名字  
    dataType–重寫屬性型別
    example–舉例說明 
    hidden–隱藏











    
    

相關推薦

Springfox Swagger2常用註解

@ApiIgnore():用於類或者方法上,可以不被swagger顯示在頁面上 @Api():用於類表示標識這個類是swagger的資源     tags–表示說明 但是tags如果有多個值,會生成多個list    value–也是說明,可以使用tags替代 (實際沒有作用

Cris 學 SpringMVC @RequestHeader 註解瞭解

使用 @RequestHeader 繫結請求報頭的屬性值 請求頭包含了若干個屬性,伺服器可據此獲知客戶端的信 息,通過 @RequestHeader 即可將請求頭中的屬性值綁 定到處理方法的入參

11. vSphere PowerCLI試用常用命令

通過命令列來管理虛擬化平臺,可以將迴圈操作的任務變得簡單,如需要批量建立多臺虛擬機器時就可以使用命令列工具。 網路上有人整理的常用命令PDF表: PowerCLI常用命令列表: 1、Connect-VIServer  – 連線虛擬化平臺 2、get-vmhost  – 顯示ESXi主機列表 3、get-

SpringBoot 入門篇 SpringBoot常用註解以及自動配置

一、SpringBoot常用註解 二、SpringBoot自動配置機制 一、SpringBoot常用註解   在上一篇文章中https://blog.csdn.net/zhichao_qzc/article/details/806421

kettle 教程常用輸出插入更新、表輸出、執行 SQL 指令碼

上一篇 文章 ,主要講了 kettle 的原理、安裝及簡單的使用。其中用到了一種輸出方式:插入更新。 這篇文章,主要介紹下常用的輸出方式:插入更新、表輸出、執行 SQL 指令碼。 插入更新 插入更新,顧名思義,包括插入和更新兩種情況。 我們需要先設定

Linux 學習之路常用命令之檔案與目錄管理

ls:顯示目標列表             -a  顯示所有檔案和目錄              -l    單列顯示詳細資訊 cd:切換工作目錄              cd     進入使用者主目錄             cd ~  進入使用者主目錄        

Python+NLTK自然語言處理學習常用方法similar、common_contexts、generate

一、similar 用來識別文章中和搜尋詞相似的詞語,可以用在搜尋引擎中的相關度識別功能中。 text1.similar("monstrous") 查詢出了text1中與monstrous相關的所有詞語: 二、common_contexts 用來識別2個

logback 常用配置詳解

logback 常用配置詳解(二) <appender> <appender>: <appender>是<configuration>的子節點,是負責寫日誌的元件。 <appender>有兩個必要屬性nam

mybatis入門篇Mybatis註解方式的基本用法

batis case left 返回 import Coding print pack hid @Select 1、mybatis-config.xml <?xml version="1.0" encoding="UTF-8" ?> <!DOCT

SpringMVC乾貨系列從零搭建SpringMVC+mybatisspringMVC原理解析及常用註解

SpringMVC框架介紹 SpringMVC就是通過DispatcherServlet將一堆元件串聯起來的Web框架。 Spring MVC屬於SpringFrameWork的後續產品,已經融合在Spring Web Flow裡面。 Spring 框架提供了構建 We

Java中String、StringBuilder、StringBuffer常用源碼分析及比較StringBuilder、StringBuffer源碼分析

string類型 character private 字符 代碼 less pri des over StringBuilder: 一、構造方法: /** * Constructs a string builder with no characters in i

Java常用的八種排序演算法與程式碼實現歸併排序法、快速排序法

注:這裡給出的程式碼方案都是通過遞迴完成的 --- 歸併排序(Merge Sort):   分而治之,遞迴實現   如果需要排序一個數組,我們先把陣列從中間分成前後兩部分,然後對前後兩部分進行分別排序,再將排好序的數組合並在一起,這樣整個陣列就有序了   歸併排序是穩定的排序演算法,時間

常用工具類HttpUtil 傳送HTTP請求

常用工具類(二):HttpUtil 傳送HTTP請求 public class HttpUtil { private static Logger logger = LoggerFactory.getLogger(HttpUtil.class); /** *

Sping Boot入門到實戰之實戰篇一些常用功能的Spring Boot Starters

包含功能 阿里雲訊息服務MNS 阿里雲訊息佇列服務(即時訊息、延遲訊息、事務訊息) AOP日誌 基於MyBatis通用Mapper及DRUID的資料庫訪問 dubbo支援 錯誤處理 七牛圖片服務 redis多連線池支援 swagger配置 跨域配置 原始碼地址:https://github.com/ron

DockerDocker常用命令之映象的建立Dockerfile 與 commit

        從鏡像倉庫下載的映象,都是別人事先做好的。如果需要一個定製的映象,就必須得自己動手了。自己建立一個映象有2種方式:a、使用commit命令基於一個現有的映象來修改。本質上並不是新建一個映象,而是基於一個已有的基礎映象進行修改。b、基於Dockerfile來建立

微服務架構實戰篇Spring boot2.0 + Swagger2 讓你的API視覺化

簡介 該專案主要利用Spring boot2.0 +Swagger2 方便進行測試後臺的restful形式的介面,實現動態的更新,當我們在後臺的介面修改了後,swagger可以實現自動的更新,而不需要認為的維護這個介面進行測試。 原始碼地址 GitHub:https:

Emacs月月積累視窗、緩衝區和常用模式切換

1 視窗和緩衝區切換 視窗 C-x 0:關閉當前視窗 C-x 1:關閉當前視窗以為的其他視窗 C-x 2:水平分割視窗 C-x 3:垂直分割視窗 C-x 4 0:關閉當前視窗和緩衝 C-x 4 b:在另

Kubernetes學習筆記Pod、標籤、註解

## pod與容器 一個pod是一組緊密相關的容器,它們總是一起執行在同一個節點上,以及同一個LInux名稱空間中。 每個pod擁有自己的ip,包含若干個容器。pod分佈在不同的節點上。 ### 為什麼需要pod 為什麼需要pod,而不是直接使用容器: 因為容器被設計為只執行一個程序,由於不能夠將多個程序聚集

Windows Phone開發10常用控件

androi chm att size near grid txt idt inf Windows Phone的控件有幾個來源,和傳統的桌面應用程序開發或Web開發一樣,有默認提供的控件和第三方開者發布的控件。一般而言,如果不是過於復雜的界面布局,使用默認控件就足矣。相比之

Javascript面向對象編程構造函數的繼承

沒有 cal type 這一 今天 nts 實現繼承 刪除 函數綁定 今天要介紹的是,對象之間的"繼承"的五種方法。 比如,現在有一個"動物"對象的構造函數。   function Animal(){     this.species = "動物";   } 還有一個