Products
96SEO 2025-06-11 06:06 1
在当今的柔软件开发领域,API文档的自动化生成已经成为一项基本需求。它不仅能够搞优良开发效率,还能确保API文档的准确性和实时性。本文将深厚入探讨怎么在Debian系统上部署Swagger,实现API文档的自动化。
Swagger是一个用于构建、测试和文档化RESTful API的有力巨大工具。它能帮开发者飞迅速生成API文档,并给交互式的API测试界面。Swagger基于OpenAPI规范,支持许多种编程语言和框架。
先说说你需要创建一个Spring Boot项目。能用Spring Initializr来生成项目,并添加所需的依赖项。
sudo apt update
sudo apt upgrade -y
sudo apt install -y openjdk-11-jdk maven git
在Spring Boot项目中,编写一个轻巧松的REST控制器。
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping
public class HelloController {
@GetMapping
public String sayHello {
return "Hello, World!";
}
}
在你的项目中的pom.xml文件中添加Swagger的依赖项:
io.springfox
springfox-swagger2
2.9.2
io.springfox
springfox-swagger-ui
2.9.2
创建一个配置类来启用Swagger,并进行少许不了的配置。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api {
return new Docket
.select
.apis)
.paths)
.build;
}
}
构建完成后你会在target目录下找到一个JAR文件。用以下命令来运行它:
java -jar target/demo-0.0.1-SNAPSHOT.jar
一旦你的应用运行起来你能你的API文档。默认情况下 Swagger UI能通过以下URL访问:
http://localhost:8080/swagger-ui.html
过程, 还能搞优良开发效率,是新潮柔软件开发中不可或缺的工具。
Demand feedback