快捷導(dǎo)航

springboot項(xiàng)目中使用Swagger的簡單示例

更新時間：2023年04月03日 11:16:12 作者：碼農(nóng)小權(quán)

大趨勢下目前很多的項(xiàng)目都采用了前后端分離的方式進(jìn)行開發(fā),最近我接觸到的項(xiàng)目大多數(shù)都是采用了前后端分離的方式進(jìn)行開發(fā),下面這篇文章主要給大家介紹了關(guān)于springboot項(xiàng)目中使用Swagger的簡單示例,需要的朋友可以參考下

1、Swagger是啥

Swagger 是一個用于生成、描述和調(diào)用 RESTful 接口的 Web 服務(wù)。通俗的來講，Swagger 就是將項(xiàng)目中所有（想要暴露的）接口展現(xiàn)在頁面上，并且可以進(jìn)行接口調(diào)用和測試的服務(wù)。 Swagger 官網(wǎng)地址：https://swagger.io/

2、Swagger有什么用？

Swagger 有以下 3 個重要的作用：將項(xiàng)目中所有的接口展現(xiàn)在頁面上，這樣后端程序員就不需要專門為前端使用者編寫專門的接口文檔；當(dāng)接口更新之后，只需要修改代碼中的 Swagger 描述就可以實(shí)時生成新的接口文檔了，從而規(guī)避了接口文檔老舊不能使用的問題；通過 Swagger 頁面，我們可以直接進(jìn)行接口調(diào)用，方便我們開發(fā)。

3、springboot中如何引入Swagger

1)在如依賴

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
 
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2）創(chuàng)建一個controller類

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class TestController {
 
    @PostMapping("/hello")
    public String hello(String str){
        return "hello,"+str;
    }
}

3）再創(chuàng)建一個Swagger配置類SwaggerConfig類

@Configuration
@EnableSwagger2//開始Swagger2
public class SwaggerConfig {
 
 
    //配置了Swagger 的Docket的bean實(shí)例
    @Bean
    public Docket docket(){
 
        ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        ticketPar.name("Authorization").description("token")//Token 以及Authorization 為自定義的參數(shù)，session保存的名字是哪個就可以寫成那個
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build(); //header中的ticket參數(shù)非必填，傳空也可以
        pars.add(ticketPar.build());    //根據(jù)每個方法名也知道當(dāng)前方法在設(shè)置什么參數(shù)
 
        return new Docket(DocumentationType.SPRING_WEB)
                .apiInfo(apiInfo())
                .select()
                //RequestHandlerSelectors, 配置要掃描接口的方式
                //basePackage:指定要掃描的包
                //any():掃描全部
                //withClassAnnotation: 掃描類上的注解
                //withMethodAnnotation: 掃描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
                .build()
                .globalOperationParameters(pars);
    }
 
    //配置Swagger 信息=apiInfo
    private ApiInfo apiInfo(){
        return new ApiInfo(
                "Logistics Api",//文檔命名
                "test",//文檔描述
                "v1.0",//
                "http:127.0.0.1/",
                null,//contact
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList()
        );
    }
}

注意！

把a(bǔ)pis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))中的

“com.example.swagger.controller ”路徑寫成你自己的controller包的路徑