使用swagger編寫開發介面文件

2021-10-05 03:28:25 字數 1620 閱讀 9912

1.在pom.xml中匯入依賴

io.springfox

springfox-swagger2

2.9.2

io.springfox

springfox-swagger-ui

2.9.2

2.在controller類中加註解

1.在類名上新增註解

@api(tags = "生成驗證碼")

@enableswagger2

public class codecontroller

2.在方法名上新增註解

①引數少的時候,用:

@apiimplicitparam(value = "時間戳", name = "timestamp")

②引數多的時候,用:

@apiimplicitparams(value = )

3.在和controller包同目錄下建立config包,存放swaggerconfig,**如下:

package config;

import org.springframework.context.annotation.bean;

import org.springframework.context.annotation.componentscan;

import org.springframework.context.annotation.configuration;

import org.springframework.web.servlet.config.annotation.enablewebmvc;

import springfox.documentation.requesthandler;

import springfox.documentation.builders.apiinfobuilder;

import springfox.documentation.builders.pathselectors;

import springfox.documentation.builders.requesthandlerselectors;

import springfox.documentation.service.apiinfo;

import springfox.documentation.spi.documentationtype;

import springfox.documentation.spring.web.plugins.docket;

import springfox.documentation.swagger2.annotations.enableswagger2;

@configuration

@enableswagger2

@enablewebmvc

//掃瞄的api  controller包

@componentscan(basepackages = "config")

public class swaggerconfig

//介面文件資訊

private apiinfo apiinfo()

}然後啟動專案,訪問http://localhost:8080/專案名/swagger-ui.html。即可

使用swagger測試介面

swagger 自動掃瞄 controller 包下的請求,生成介面文件,並提供測試功能。1.引入依賴 io.springfox springfox swagger2 2.9.2 io.springfox springfox swagger ui 2.9.2 在 config 包引入 swagger...

Web開發 使用Swagger

這個解釋簡單點來講就是說,swagger是一款可以根據resutful風格生成的生成的介面開發文件,並且支援做測試的一款中間軟體。2.1 對於後端開發人員來說 不用再手寫wiki介面拼大量的引數,避免手寫錯誤 對 侵入性低,採用全註解的方式,開發簡單 方法引數名修改 增加 減少引數都可以直接生效,不...

swagger介面文件的使用

1.訪問位址為專案路徑 swagger ui.html 2.swagger的配置使用 配置swagger的docket和apiinfo configuration enableswagger2 配置swagger public class swaggerconfiguration 配置檔案裡面設定為...