在Debian系统上查看Swagger文档,通常需要以下几个步骤:
- 安装Java和Maven:Swagger通常与Spring Boot项目一起使用,因此你需要一个Spring Boot项目模板。首先,确保你的Debian系统已经安装了Java和Maven(或其他构建工具)。
sudo apt update sudo apt install openjdk-11-jdk java -version sudo apt install maven mvn -version
-
创建Spring Boot项目:你可以使用Spring Initializr(https://start.spring.io/)来创建一个新的Spring Boot项目,选择必要的依赖,例如
springfox-boot-starter
。 -
引入Swagger依赖:在你的Spring Boot项目的
pom.xml
文件中添加Swagger依赖:
io.springfox springfox-boot-starter 3.0.0
- 配置Swagger:在
application.yml
或application.properties
文件中配置Swagger:
application.yml
:
springfox: documentation: swagger-ui: enabled: true
或application.properties
:
springfox.documentation.swagger-ui.enabled=true
- 启动项目:启动你的Spring Boot项目,通常可以通过以下命令:
mvn spring-boot:run
- 访问Swagger UI:项目启动后,打开浏览器,访问以下URL来查看Swagger生成的API文档:
http://localhost:8080/swagger-ui/
- 编写API接口并使用Swagger注解:在你的控制器类中使用Swagger注解来描述API接口:
import io.swagger.annotations.*; import org.springframework.web.bind.annotation.*; @RestController @RequestMapping("/api") @Api(tags = "Sample API") public class SampleController { @GetMapping("/hello") @ApiOperation(value = "https://www.yisu.com/ask/Say hello", response = String.class) public String sayHello() { return "Hello, World!"; } @PostMapping("/data") @ApiOperation(value = "https://www.yisu.com/ask/Send data", requestBody = @io.swagger.annotations.ApiRequestBody(content = @io.swagger.annotations.ApiContent(schema = @io.swagger.annotations.ApiSchema(implementation = String.class))), response = String.class) public String sendData(@RequestBody String data) { return "Received: " + data; } }
- 访问API文档:在Swagger UI中,你可以看到所有通过注解描述的API接口,可以在线尝试调用这些接口,查看请求和响应示例。
请注意,以上步骤是基于Spring Boot项目使用Swagger的常见情况。如果你的项目不是Spring Boot项目,可能需要使用其他方法来查看Swagger文档。