2025年swagger2配置（swagger2配置登录）

科技前沿 • 2025-05-04 23:43 • 阅读 36

大家好，我是讯享网，很高兴认识大家。

您好，以下是springboot整合swagger2的步骤demo：

在pom.xml文件中添加swagger2的依赖：

&lt;dependency&gt; &lt;groupId&gt;io.<em>spring</em>fox&lt;/groupId&gt; &lt;artifactId&gt;<em>spring</em>fox-<em>swagger</em>2&lt;/artifactId&gt; &lt;version&gt;2.9.2&lt;/version&gt; &lt;/dependency&gt;

讯享网

创建Swagger2配置类，用于配置Swagger2相关信息：

讯享网@Configuration @Enable<em>Swagger</em>2 public class <em>Swagger</em>2Config { @Bean public Docket createRestApi() { return new Docket(DocumentationType.<em>SWAGGER</em>_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage(&quot;com.example.<em>demo</em>.controller&quot;)) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title(&quot;<em>Spring</em> <em>Boot</em>中使用<em>Swagger</em>2构建RESTful APIs&quot;) .description(&quot;更多<em>Spring</em> <em>Boot</em>相关文章请关注：http://www.example.com/&quot;) .termsOfServiceUrl(&quot;http://www.example.com/&quot;) .contact(&quot;example&quot;) .version(&quot;1.0&quot;) .build(); } }

在Controller类中添加Swagger2注解，用于描述接口信息：

@RestController @RequestMapping(&quot;/user&quot;) @Api(tags = &quot;用户管理&quot;) public class UserController { @ApiOperation(value = &quot;获取用户列表&quot;, notes = &quot;获取所有用户列表&quot;) @GetMapping(&quot;/list&quot;) public List&lt;User&gt; list() { // ... } @ApiOperation(value = &quot;创建用户&quot;, notes = &quot;根据User对象创建用户&quot;) @ApiImplicitParam(name = &quot;user&quot;, value = &quot;用户实体&quot;, required = true, dataType = &quot;User&quot;) @PostMapping(&quot;/create&quot;) public String create(@RequestBody User user) { // ... } @ApiOperation(value = &quot;更新用户&quot;, notes = &quot;根据User对象更新用户&quot;) @ApiImplicitParams({ @ApiImplicitParam(name = &quot;id&quot;, value = &quot;用户ID&quot;, required = true, dataType = &quot;Long&quot;), @ApiImplicitParam(name = &quot;user&quot;, value = &quot;用户实体&quot;, required = true, dataType = &quot;User&quot;) }) @PutMapping(&quot;/update/{id}&quot;) public String update(@PathVariable Long id, @RequestBody User user) { // ... } @ApiOperation(value = &quot;删除用户&quot;, notes = &quot;根据ID删除用户&quot;) @ApiImplicitParam(name = &quot;id&quot;, value = &quot;用户ID&quot;, required = true, dataType = &quot;Long&quot;) @DeleteMapping(&quot;/delete/{id}&quot;) public String delete(@PathVariable Long id) { // ... } }

启动应用程序，访问http://localhost:8080/swagger-ui.html，即可查看Swagger2生成的接口文档。

希望对您有所帮助！

2025年swagger2配置（swagger2配置登录）

相关推荐