Swagger的使用及註解說明

一、使用方法

在pom.xml中加入swagger2的依賴

io.springfox

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

建立swagger2配置類

@configuration

@enableswagger2
public class swagger2 
private apiinfo apiinfo() 
}

通過@configuration註解，讓spring來載入該類配置。再通過@enableswagger2註解來啟用swagger2。

再通過createrestapi函式建立docket的bean之後，apiinfo()用來建立該api的基本資訊（這些基本資訊會展現在文件頁面中）。select()函式返回乙個apiselectorbuilder例項用來控制哪些介面暴露給swagger來展現，本例採用指定掃瞄的包路徑來定義，swagger會掃瞄該包下所有controller定義的api，並產生文件內容（除了被@apiignore指定的請求）。

@api(value = "user",  tags = "使用者模組")

@restcontroller
public class usercontroller extends basecontroller )
public resultbean adduser(user user)
}

二、解決404的問題

import org.springframework.context.annotation.configuration;

import org.springframework.web.servlet.config.annotation.resourcehandlerregistry;
import org.springframework.web.servlet.config.annotation.webmvcconfigurationsupport;
@configuration
public class swaggerconfiger extends webmvcconfigurationsupport
}

作用範圍

api使用位置

物件屬性

@apimodelproperty

用於出入引數物件的字段上

協議集描述

@api

用於controller類上

協議描述

@apioperation

用在controller的方法上

response集

@apiresponses

用在controller的方法上

response

@apiresponse

用在 @apiresponses裡邊

非物件引數集

@apiimplicitparams

用在controller的方法上

非物件引數描述

@apiimplicitparam

用在@apiimplicitparams的方法裡邊

描述返回物件的意義

@apimodel

用在返回物件類上

關於引數的詳細解釋

屬性取值

作用paramtype

查詢引數型別

path

以位址的形式提交資料

query

直接跟引數完成自動對映賦值

body

以流的形式提交 僅支援post

header

引數在request headers 裡邊提交

form

以form表單的形式提交 僅支援post

datatype

引數的資料型別 只作為標誌說明，並沒有實際驗證

long

string

name

接收引數名（必須與方法中引數名一致）

value

接收引數的意義描述（描述資訊）

required

引數是否必填

true

必填false

非必填defaultvalue

預設值

swagger註解說明

前言 使用swagger的主要好處就是不用手動寫文件了，通過註解就可以自動化文件。文件和 同步更新，更新之後不需要再更新文件。使用swagger框架可以除錯api，在瀏覽器端可以看到更多的 request 和 response 資訊。本文章重點描述下swagger應用注釋說明。示例 首先是 cmsc...

Swagger註解說明

1.api 用在類上，說明該類的作用 api value usercontroller description 使用者相關api 2.apioperation 用在方法上，說明方法的作用 3 apiimplicitparams 用在方法上包含一組引數說明 4.apiimplicitparam 用在 ...

Swagger註解說明

常用註解 api 用於類 表示標識這個類是swagger的資源 apioperation 用於方法 表示乙個http請求的操作 apiparam 用於方法，引數，字段說明 表示對引數的新增元資料 說明或是否必填等 apimodel 用於類 表示對類進行說明，用於引數用實體類接收 apimodelpr...