8.SpringBoot3 整合 Swagger3
由于目前主流的開發模式是前后端分離開發。所以前后端的交互需要通過一個 API(開發接口) 來規范。而這個接口的開發是由后端程序員編寫的。“網站式 API 文檔”
1.導入依賴
<!-- 引入swagger3(springdoc)的依賴-->
<dependency><groupId>org.springdoc</groupId><artifactId>springdoc-openapi-starter-webmvc-ui</artifactId><version>2.8.9</version>
</dependency>
2.編寫 Swagger3 的配置類
@Configuration
public class SwaggerConfig {@Beanpublic OpenAPI apiConfig() {return new OpenAPI().info(info()).externalDocs(new ExternalDocumentation().description("外部文檔").url("https://springshop.wiki.github.org/docs"));}private Info info() {return new Info().title("項目名稱").description("項目描述信息").contact(new Contact().name("Touper").url("https://www.itszb.com").email("3245349849@qq.com")).version("1.0");}
}
3.在啟動類上開啟 swagger 注解開發
4.編寫 Controller 方法API
?
5.編寫 Controller 方法參數API
1.普通參數
2.復雜參數
其中新增和更新傳入的是一個對象,所以他的 API 編寫比較特殊。要在實體類里面編寫
6.結果展示
7.訪問網址
http://localhost:8080/swagger-ui/index.html