中文字幕av专区_日韩电影在线播放_精品国产精品久久一区免费式_av在线免费观看网站

溫馨提示×

如何文檔化Spring Boot Endpoints

小樊
83
2024-09-14 09:18:05
欄目: 編程語言

要文檔化Spring Boot Endpoints,我們建議使用Swagger

  1. 添加Swagger依賴項

pom.xml中添加以下依賴項:

   <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>
  1. 創建Swagger配置類

在項目中創建一個新的Java類,例如SwaggerConfig.java,然后添加以下代碼:

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
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.yourapp"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfo(
                "Your App Title",
                "Your App Description",
                "API Version",
                "Terms of Service URL",
                new Contact("Name", "URL", "Email"),
                "License Name",
                "License URL",
                Collections.emptyList()
        );
    }
}
  1. 更新application.properties(或者application.yml)

application.properties文件中添加以下內容:

springfox.documentation.swagger.v2.path=/api-docs

或者在application.yml中添加以下內容:

springfox:
  documentation:
    swagger:
      v2:
        path: /api-docs
  1. 訪問Swagger UI

啟動你的Spring Boot應用程序,然后在瀏覽器中訪問以下URL:

http://localhost:8080/swagger-ui.html

這將顯示Swagger UI,您可以在其中查看和測試您的Spring Boot Endpoints。

注意:請確保將"com.example.yourapp"替換為您自己的基本包名稱。

0
孟津县| 西丰县| 无锡市| 治县。| 原阳县| 瑞安市| 舟山市| 军事| 洱源县| 古蔺县| 讷河市| 九寨沟县| 马鞍山市| 永登县| 永寿县| 灵石县| 四会市| 乌海市| 福建省| 禹州市| 北海市| 张掖市| 洛川县| 博乐市| 沙田区| 隆德县| 通江县| 甘孜县| 茌平县| 永丰县| 南京市| 中超| 扶沟县| 壶关县| 井研县| 山东省| 汉寿县| 荃湾区| 苏州市| 荣昌县| 兴隆县|