springboot使用knife4j的步骤
时间: 2023-09-28 22:06:01 浏览: 156
好的,下面是使用Spring Boot集成Knife4j的步骤:
1. 在Maven或Gradle中添加Knife4j的依赖:
```
<!-- Swagger 接口文档工具 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
```
2. 在Spring Boot主类上添加`@EnableKnife4j`注解:
```
@SpringBootApplication
@EnableKnife4j
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
```
3. 在`application.properties`或`application.yml`中配置Swagger相关参数,如下:
```
# Swagger配置
swagger.enabled=true # 是否开启Swagger
swagger.title=My API # 接口文档标题
swagger.description=My API接口文档 # 接口文档描述
swagger.version=1.0 # 接口文档版本号
swagger.contact.name=My Name # 联系人姓名
swagger.contact.url=http://www.example.com # 联系人URL
swagger.contact.email=myname@example.com # 联系人邮箱
```
4. 启动应用,访问`http://localhost:8080/doc.html`即可看到生成的API文档。
以上就是使用Spring Boot集成Knife4j的步骤,希望能对你有所帮助。如果有任何疑问,欢迎随时提出。
阅读全文