一. 介紹

使用Swagger你只需要按照它的規(guī)范去定義接口及接口相關(guān)的信息，就可以做到生成接口文檔，以及在線接口調(diào)試頁(yè)面。

官網(wǎng):https://swagger.io/

二.什么是Knife4j

Knife4j是為Java MVC框架集成Swagger生成Api文檔的增強(qiáng)解決方案。

三. swagger的使用步驟

1.導(dǎo)入 knife4j的maven坐標(biāo)

2.在配置類中加入 knife4j相關(guān)配置

3.設(shè)置靜態(tài)資源映射，否則接口文檔頁(yè)面無(wú)法訪問(wèn)

四. 具體使用步驟 

4.1 引入依賴

 <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
            <version>4.5.0</version>
        </dependency>

4.2 創(chuàng)建一個(gè)包和類

4.3 直接把下面的代碼粘貼到這個(gè)類中

/**
 * 配置類，注冊(cè)web層相關(guān)組件
 */
@Configuration
public class WebMvcConfiguration extends WebMvcConfigurationSupport {
 
    /**
     * 通過(guò)knife4j生成接口文檔
     * @return
     */
    @Bean
    public Docket docket() {
        System.out.println("準(zhǔn)備生成接口文檔..");
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("蒼穹外賣項(xiàng)目接口文檔")
                .version("2.0")
                .description("蒼穹外賣項(xiàng)目接口文檔")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("idea_students.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
 
    /**
     * 設(shè)置靜態(tài)資源映射
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        System.out.println("開(kāi)始進(jìn)行靜態(tài)資源映射...");
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}
 
 
 
 

4.4 修改基本的信息

五.總結(jié)

Swagger 是用于設(shè)計(jì)、構(gòu)建、記錄和使用 RESTful API 的開(kāi)源工具集，基于 OpenAPI 規(guī)范（OAS）實(shí)現(xiàn) API 文檔的標(biāo)準(zhǔn)化管理。其核心價(jià)值在于通過(guò)自動(dòng)化文檔生成解決傳統(tǒng)手動(dòng)維護(hù)文檔滯后的問(wèn)題，同時(shí)提供可視化調(diào)試與代碼生成能力，提升前后端協(xié)作效率。

在功能層面，Swagger 支持用 YAML 或 JSON 格式描述 API 接口的路徑、參數(shù)、請(qǐng)求 / 響應(yīng)格式等要素，確保文檔與代碼實(shí)時(shí)同步。Swagger UI 組件提供圖形化界面，允許開(kāi)發(fā)者直接測(cè)試接口并查看響應(yīng)結(jié)果，無(wú)需依賴額外工具；Swagger Codegen 則可根據(jù)文檔自動(dòng)生成 Java、Python、JavaScript 等語(yǔ)言的客戶端 SDK 與服務(wù)端代碼框架，減少重復(fù)開(kāi)發(fā)量。此外，其支持將文檔集成到 CI/CD 流程或部署至 SwaggerHub 等平臺(tái)，實(shí)現(xiàn)團(tuán)隊(duì)協(xié)作與文檔共享。

從技術(shù)生態(tài)看，OpenAPI 規(guī)范當(dāng)前最新版本為 3.1，支持更靈活的參數(shù)類型定義與 JWT、OAuth 等安全機(jī)制；Swagger Editor 提供在線文檔編輯與實(shí)時(shí)預(yù)覽功能，配合語(yǔ)法校驗(yàn)確保文檔準(zhǔn)確性。實(shí)際應(yīng)用中，Swagger 常被集成到 Spring Boot、Node.js 等框架中，通過(guò)注解（如 @Api、@ApiOperation）自動(dòng)生成文檔，或通過(guò) Docker 容器化部署實(shí)現(xiàn)輕量化管理，已成為現(xiàn)代 API 開(kāi)發(fā)中不可或缺的文檔與協(xié)作工具。

以上就是Java中Swagger生成后端接口測(cè)試的詳細(xì)教程的詳細(xì)內(nèi)容，更多關(guān)于Java Swagger生成后端接口測(cè)試的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！