我要评论
本文介绍如何在spring boot项目中集成swagger，方便api文档的生成和测试。 以下步骤将指导您完成集成过程：
1. 添加依赖项:
在您的pom.xml文件中添加以下依赖：
<dependency>
<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>登录后复制
请根据您的项目需求选择合适的版本号。
2. swagger配置:
创建一个名为swaggerconfig.java的类，并添加以下代码：
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;
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("your.base.package")) //替换为您的控制器包名
.paths(pathselectors.any())
.build();
}
}登录后复制
记住将"your.base.package"替换成您spring boot项目中控制器类的包名。
3. 访问swagger ui:
启动spring boot应用后，在浏览器中访问以下url：
http://localhost:8080/swagger-ui.html
登录后复制
您应该能够看到swagger ui界面，其中列出了所有可用的api。
4. 高级配置 (可选):
您可以进一步自定义swagger配置，例如添加api信息、全局参数等。以下是一个更详细的配置示例：
import springfox.documentation.builders.*;
import springfox.documentation.schema.modelref;
import springfox.documentation.service.apiinfo;
import springfox.documentation.service.parameter;
import springfox.documentation.spi.documentationtype;
import springfox.documentation.spring.web.plugins.docket;
import springfox.documentation.swagger2.annotations.enableswagger2;
import java.util.arraylist;
import java.util.list;
@configuration
@enableswagger2
public class swaggerconfig {
@bean
public docket api() {
list<parameter> params = new arraylist<>();
params.add(new parameterbuilder()
.name("authorization")
.description("access token")
.modelref(new modelref("string"))
.parametertype("header")
.required(false)
.build());
apiinfo apiinfo = new apiinfobuilder()
.title("my api")
.description("my api description")
.version("1.0.0")
.contact("your name")
.build();
return new docket(documentationtype.swagger_2)
.apiinfo(apiinfo)
.select()
.apis(requesthandlerselectors.basepackage("your.base.package")) //替换为您的控制器包名
.paths(pathselectors.any())
.build()
.globaloperationparameters(params);
}
}登录后复制
完成以上步骤后，您就成功将swagger集成到spring boot项目中了，可以使用swagger ui方便地浏览和测试您的api。
以上就是linux swagger与spring boot如何结合使用的详细内容，更多请关注代码网其它相关文章！
发表评论