資訊專(zhuān)欄INFORMATION COLUMN
摘要：在做項(xiàng)目的時(shí)候?qū)τ诘囊?guī)范特別重要以前用了感覺(jué)挺好用但是就是有點(diǎn)麻煩現(xiàn)在中可以使用注解的方式來(lái)逆向生成文檔以下是使用步驟在文件中引入依賴(lài)在項(xiàng)目的配置文件中添加一個(gè)文件夾里面添加一個(gè)配置類(lèi)用來(lái)描述哪些包下面會(huì)被掃描變成文檔網(wǎng)頁(yè)文檔網(wǎng)頁(yè)文檔
在做項(xiàng)目的時(shí)候?qū)τ赼pi的規(guī)范特別重要,以前用了swagger,感覺(jué)挺好用,但是就是有點(diǎn)麻煩,現(xiàn)在springboot中可以使用注解的方式來(lái)逆向生成swagger文檔,以下是使用步驟:
1.在pom文件中引入依賴(lài)
io.springfox springfox-swagger2 io.springfox springfox-swagger-ui
2.在項(xiàng)目的配置文件中添加一個(gè)config文件夾,里面添加一個(gè)配置類(lèi),用來(lái)描述哪些包下面會(huì)被掃描變成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("網(wǎng)頁(yè)api文檔")
.description("網(wǎng)頁(yè)api文檔")
// .termsOfServiceUrl("/")
.version("1.0")
.build();
}
}
在Java類(lèi)中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下：
@Api：修飾整個(gè)類(lèi)，描述Controller的作用
@ApiOperation：描述一個(gè)類(lèi)的一個(gè)方法，或者說(shuō)一個(gè)接口
@ApiParam：?jiǎn)蝹€(gè)參數(shù)描述
@ApiModel：用對(duì)象來(lái)接收參數(shù)
@ApiModelProperty：用對(duì)象接收參數(shù)時(shí)，描述對(duì)象的一個(gè)字段
@ApiResponse：HTTP響應(yīng)其中1個(gè)描述
@ApiResponses：HTTP響應(yīng)整體描述
@ApiIgnore：使用該注解忽略這個(gè)API
@ApiError ：發(fā)生錯(cuò)誤返回的信息
@ApiImplicitParam：一個(gè)請(qǐng)求參數(shù)
@ApiImplicitParams：多個(gè)請(qǐng)求參數(shù)
@ApiImplicitParam屬性：
例子:
//首先在接口上面描述接口的作用,詳情和參數(shù)
@Api(value="頁(yè)面管理接口",description = "頁(yè)面管理接口，提供頁(yè)面的增、刪、改、查")
public interface PageControllerApi {
@ApiOperation("分頁(yè)查詢(xún)頁(yè)面列表")
@ApiImplicitParams({
@ApiImplicitParam(name="page",value = "頁(yè)
碼",required=true,paramType="path",dataType="int"),
@ApiImplicitParam(name="size",value = "每頁(yè)記錄
數(shù)",required=true,paramType="path",dataType="int")
})
public QueryResponseResult findList(int page, int size) ;
}
//使用@ApiModelProperty描述模型類(lèi)的各個(gè)字段
@Data
public class QueryPageRequest {
//接受頁(yè)面的條件參數(shù)
//站點(diǎn)id
@ApiModelProperty("頁(yè)面id")
String pageId;
}
文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址：http://www.ezyhdfw.cn/yun/74123.html
摘要：新手上路搭建項(xiàng)目是一個(gè)接口文檔軟件界面如下添加這里使用版本可以正常使用配置文件測(cè)試新手上路。 新手上路-搭建項(xiàng)目-springboot-swagger2 swagger2 是一個(gè)接口文檔軟件 界面如下 showImg(https://segmentfault.com/img/bVOoim); gradle添加 compile(io.springfox:springfox-swagger...
摘要：另外很容易構(gòu)建風(fēng)格的，簡(jiǎn)單優(yōu)雅帥氣，正如它的名字。配置一些基本的信息。三寫(xiě)生產(chǎn)文檔的注解通過(guò)注解表明該接口會(huì)生成文檔，包括接口名請(qǐng)求方法參數(shù)返回信息的等等。四參考資料中使用構(gòu)建強(qiáng)大的文檔 swagger,中文拽的意思。它是一個(gè)功能強(qiáng)大的api框架，它的集成非常簡(jiǎn)單，不僅提供了在線(xiàn)文檔的查閱，而且還提供了在線(xiàn)文檔的測(cè)試。另外swagger很容易構(gòu)建restful風(fēng)格的api，簡(jiǎn)單優(yōu)雅帥氣...
摘要：今天給你們帶來(lái)集成的教程。接口返回結(jié)果不明確。這些痛點(diǎn)在前后端分離的大型項(xiàng)目上顯得尤為煩躁。接口返回結(jié)果非常明確，包括數(shù)據(jù)類(lèi)型，狀態(tài)碼，錯(cuò)誤信息等。生成后的文件依賴(lài)如下這里使用的是的版本。另外，關(guān)注之后在發(fā)送可領(lǐng)取免費(fèi)學(xué)習(xí)資料。 微信公眾號(hào)：一個(gè)優(yōu)秀的廢人如有問(wèn)題或建議，請(qǐng)后臺(tái)留言，我會(huì)盡力解決你的問(wèn)題。 前言 快過(guò)年了，不知道你們啥時(shí)候放年假，忙不忙。反正我是挺閑的，所以有時(shí)間寫(xiě) b...
閱讀 961·2021-10-09 09:58
閱讀 794·2021-08-27 16:24
閱讀 1870·2019-08-30 14:15
閱讀 2520·2019-08-30 11:04
閱讀 2246·2019-08-29 18:43
閱讀 2307·2019-08-29 15:20
閱讀 2867·2019-08-26 12:20
閱讀 1782·2019-08-26 11:44
