浅析如何使用Swagger生成带权限控制的API文档

本文主要是介绍浅析如何使用Swagger生成带权限控制的API文档，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

《浅析如何使用Swagger生成带权限控制的API文档》当涉及到权限控制时,如何生成既安全又详细的API文档就成了一个关键问题,所以这篇文章小编就来和大家好好聊聊如何用Swagger来生成带有...

在咱们的开发工作里，API 文档就像是项目的说明书，清晰准确的文档能让我们的开发效率大幅提升。而当涉及到权限控制时，如何生成既安全又详细javascript的 API 文档就成了一个关键问题。今天，我就和大家好好唠唠如何用 Swagger 来生成带有权限控制的 API 文档。

准备工作

咱们做开发，就像行军打仗，工具和资源就是我们的“粮草”。在使用 Swagger 生成带权限控制的 API 文档之前，得先把相关的依赖添加到项目里。如果你用的是 Maven 项目，在 pom.XML 里加上下面这些依赖：

<dependencies>
    <!-- Swagger API 注解 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <!-- Swagger UI -->
  MMaEye  <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
    <!-- Spring Security -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
</dependencies>

这些依赖就像是我们的武器装备，有了它们，我们才能在开发的战场上“披荆斩棘”。

配置 Swagger

有了依赖，接下来就要对 Swagger 进行配置，让它能按照我们的需求生成 API 文档。创建一个 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.DoChina编程cket;
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("com.example.controller"))
               .paths(PathSelectors.any(http://www.chinasem.cn))
               .build();
    }
}

这里我们指定了要扫描的控制器包路径，这样 Swagger 就能知道从哪里获取 API 的信息了。

权限控制

在实际的项目中，API 文档往往包含了很多敏感信息，所以给文档加上权限控制是非常必要的。我们用 Spring Security 来实现这个功能，创建一个 Spring Security 配置类：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.phpcore.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.provisioning.InMemoryUserDetailsManager;
import org.springframework.security.web.SecurityFilterChain;
 
@Configuration
@EnableWebSecurity
public class SecurityConfig {
 
    @Bean
    public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
        http
               .authorizeRequests()
               .antMatchers("/swagger-ui.html", "/swagger-resources/**", "/v2/api-docs").hasRole("ADMIN")
               .anyRequest().authenticated()
               .and()
               .httpBasic();
        return http.build();
    }
 
    @Bean
    public UserDetailsService userDetailsService() {
        UserDetails user =
             User.withDefaultPasswordEncoder()
               .username("admin")
               .password("password")
               .roles("ADMIN")
               .build();
 
        return new InMemoryUserDetailsManager(user);
    }
}

在这个配置里，我们规定只有拥有 ADMIN 角色的用户才能访问 Swagger UI 和 API 文档相关的路径，就像给文档加上了一把安全锁，只有有钥匙的人才能打开。

给 API 加上权限注解

在控制器的方法上，我们要添加权限注解和 Swagger 注解，这样在生成的文档里就能清楚地看到每个 API 的权限要求了：

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.security.Access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
@RequestMapping("/api")
@Api(value = "示例 API", description = "这是一个带有权限控制的示例 API 文档")
public class ExampleController {
 
    @GetMapping("/hello")
    @ApiOperation(value = "获取问候语", notes = "需要 ADMIN 角色才能访问")
    @PreAuthorize("hasRole('ADMIN')")
    public String hello() {
        return "Hello, World!";
    }
}

这里用 @PreAuthorize 注解对方法进行权限控制，同时在 @ApiOperation 注解的 notes 属性中说明权限要求，就像给每个 API 贴上了一个“使用说明”。

查看文档

当我们完成了以上所有步骤，就可以启动 Spring Boot 应用程序，然后访问 http://localhost:8080/swagger-ui.html（端口号根据实际情况修改）。这时浏览器会弹出 HTTP Basic 认证对话框，输入我们在 SecurityConfig 中配置的用户名和密码（这里是 admin 和 password），认证通过后就能看到带有权限信息的 API 文档了，就像打开了一扇通往知识宝库的大门。