SpringBootにswagger 2インターフェースドキュメントを追加し、グローバルAuthorzationパラメータを追加します.

依存パケット

    io.springfox
    springfox-swagger2
    2.6.1



    io.springfox
    springfox-swagger-ui
    2.6.1

設定クラス(securitySchemesとsecurityContectsの役割は大域Authorzationパラメータを設定するため)

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    //http://localhost:9007/swagger-ui.html
    @Bean
    public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.com.dinglisec.iot.uaa.api"))
                .paths(PathSelectors.any())
                .build()
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot  swagger  api  ")
                .description("     restful  ")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }

    private List securitySchemes() {
        List apiKeys = new ArrayList<>();
        apiKeys.add(new ApiKey("Authorization", "Authorization", "header"));
        return apiKeys;
    }

    private List securityContexts() {
        List securityContexts = new ArrayList<>();
        securityContexts.add(SecurityContext.builder()
                .securityReferences(defaultAuth())
                .forPaths(PathSelectors.regex("^(?!auth).*$")).build());
        return securityContexts;
    }

    private List defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List securityReferences = new ArrayList<>();
        securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
        return securityReferences;
    }

}

インターフェース正常パラメータ設定

@ApiOperation(value="  ", notes="            ")
    @ApiImplicitParams({@ApiImplicitParam(name = "username", value = "   ", required = true, dataType = "String", paramType = "query"),
            @ApiImplicitParam(name = "password", value = "  ", required = true, dataType = "String", paramType = "query")})
    @RequestMapping(value = "login", method = GET)
    public Message login(String username, String password) {
        //......
    }

インターフェースエンティティ類パラメータ配置

@ApiOperation(value="            ", notes="            ")
    @GetMapping(value = "userPageSet", produces = APPLICATION_JSON_UTF8_VALUE)
    @PreAuthorize("hasPermission('user', 'select')")
    public Page getUserByRoleName(@ApiParam(name="      ",value="  json  ",required=true) GetRoleUserListRequest req, @ApiParam(name="    ",value="  json  ",required=true) @PageableDefault(page=0,size=10) Pageable pageable) {
        // ......
    }

または

@ApiOperation(value="        ", notes="        ")
    @ApiImplicitParam(name = "req", value = "       ", required = true, dataType = "ChangePasswordRequest")
    @PutMapping(value = "user/password")
    @PreAuthorize("hasPermission('user', 'update')")
    public Message updatePassword(@RequestBody ChangePasswordRequest req) {
        // ......
    }

インターフェースドキュメントリンクhttp://localhost:9007/swagger-ui.
グローバルtokenを設定