SpringBootでAPIドキュメントを自動生成する方法は何ですか？

10か月 ago

蓮, 翼

1 minute

SpringBootでAPIドキュメントの自動生成を実装する場合、通常はSwaggerを使用します。SwaggerはAPIを設計、構築、ドキュメント化するためのツールであり、APIドキュメントを簡単に生成し、開発者やユーザーがAPIの機能や使用方法を直感的に理解できるインタラクティブなUIを提供します。

SpringBootでSwaggerを使用して自動でAPIドキュメントを生成する手順は次のとおりです。

pom.xmlにSwaggerの依存関係を追加してください。

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

Swaggerを有効にするために、起動クラスに@EnableSwagger2アノテーションを追加してください。

@SpringBootApplication
@EnableSwagger2
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Swaggerに関連する情報を設定するSwaggerConfigクラスを作成してください。

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

Controllerクラスを作成し、メソッドにSwaggerアノテーションを使用してください。

@RestController
public class ExampleController {

    @ApiOperation("获取用户信息")
    @GetMapping("/user/{id}")
    public User getUser(@PathVariable Long id) {
        // code
    }
}

http://localhost:8080/swagger-ui/にアクセスすると、生成されたAPIドキュメントを確認できます。

SpringBootプロジェクトでのインターフェースドキュメントの自動生成およびSwaggerのUIインターフェースを使用してインターフェースドキュメントを簡単に表示することができます。