SpringBoot與Swagger的整合

2021-09-26 07:04:05 字數 2071 閱讀 2112

swagger是乙個完整的框架,用於自動生成介面文件,可極大減少後台開發人員的介面文件編輯所消耗的時間,並保證介面文件風格的一致性。

在專案的pom.xml檔案中插入如下**,版本號自行選擇。

>

>

io.springfoxgroupid

>

>

springfox-swagger2artifactid

>

>

2.6.1version

>

dependency

>

>

>

io.springfoxgroupid

>

>

springfox-swagger-uiartifactid

>

>

2.6.1version

>

dependency

>

package com.test.swagger.conf;

import org.springframework.context.annotation.bean;

import org.springframework.context.annotation.configuration;

import springfox.documentation.builders.apiinfobuilder;

import springfox.documentation.builders.pathselectors;

import springfox.documentation.builders.requesthandlerselectors;

import springfox.documentation.service.apiinfo;

import springfox.documentation.service.contact;

import springfox.documentation.spi.documentationtype;

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

import springfox.documentation.swagger2.annotations.enableswagger2;

@configuration

@enableswagger2

//開啟swagger

public

class

swaggerconf

//構建 api文件的詳細資訊函式

private apiinfo apiinfo()

}

package com.test.swagger.controller;

import io.swagger.annotations.apiimplicitparam;

import io.swagger.annotations.apiimplicitparams;

import io.swagger.annotations.apioperation;

import org.springframework.context.annotation.description;

import org.springframework.web.bind.annotation.*;

@restcontroller

(value =

"/test"

)public

class

testcontroller

)public string test

(int param1, string param2)

return

"引數校驗異常";}

}

測試專案搭建好,並且按照上述配置了swagger後,便可啟動專案測試一下結果。

乙個簡單的介面文件搭建完畢了,後期將會更新swagger的一些註解詳情。

springboot專案實踐 整合swagger

1.在pom檔案中做如下配置 io.springfoxgroupid springfox swagger2artifactid 2.9.2version dependency io.springfoxgroupid springfox swagger uiartifactid 2.9.2versio...

SpringBoot整合系列 整合Swagger2

io.springfox springfox swagger2 2.7.0 io.springfox springfox swagger ui 2.7.0 一般無配置項,必要時可以新增自定義配置項,在配置類中讀取 swagger2的配置內容僅僅就是需要建立乙個docket例項 configurati...

在springboot專案中使用swaggerui

在pom.xml檔案中配置 用的2.6.1版本,2.9.2有點醜 properties spring.swagger2.version 2.6.1 spring.swagger2.version properties dependency groupid io.springfox groupid a...