Документирование API входа / выхода Spring в Swagger

Я занимаюсь разработкой демо REST сервиса, используя Spring Boot где пользователь должен войти в систему, чтобы выполнить определенное подмножество операций. После добавления Swagger UI (с помощью springfox библиотека) с этой простой конфигурацией:

@Bean
public Docket docApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
                .apis(any())
                .paths(PathSelectors.ant("/api/**"))
                .build()
            .pathMapping("/")
            .apiInfo(apiInfo())
            .directModelSubstitute(LocalDate.class, String.class)
            .useDefaultResponseMessages(true)
            .enableUrlTemplating(true);
}

Я в конечном итоге все apis со всеми операциями, перечисленными на Swagger UI стр. К сожалению, у меня нет конечных точек входа / выхода.

Проблема в том, что часть этих операций не может быть выполнена с помощью Swagger UI встроенная форма (я нахожу это действительно хорошей функцией и хотела бы, чтобы она работала), потому что пользователь не вошел в систему. Есть ли решение этой проблемы? Могу ли я определить вручную некоторые конечные точки в Swagger?

Если бы существовала форма для отправки учетных данных (например, конечные точки входа / выхода), я мог бы выполнить авторизацию перед использованием этих защищенных конечных точек. Затем, Swagger пользователь может извлечь token/sessionid из ответа и вставьте его в пользовательский параметр запроса, определенный с помощью @ApiImplicitParams,

Ниже вы можете найти мою конфигурацию безопасности:

@Override
protected void configure(HttpSecurity http) throws Exception {
    http
            .formLogin()
                .loginProcessingUrl("/api/login")
                .usernameParameter("username")
                .passwordParameter("password")
                .successHandler(new CustomAuthenticationSuccessHandler())
                .failureHandler(new CustomAuthenticationFailureHandler())
                .permitAll()
                .and()
            .logout()
                .logoutUrl("/api/logout")
                .logoutSuccessHandler(new CustomLogoutSuccessHandler())
                .deleteCookies("JSESSIONID")
                .permitAll()
                .and()
            .csrf()
                .disable()
            .exceptionHandling()
                .authenticationEntryPoint(new CustomAuthenticationEntryPoint())
                .and()
            .authorizeRequests()
            .and()
                .headers()
                .frameOptions()
                .disable();
}

@Override
protected void configure(AuthenticationManagerBuilder auth) throws Exception {
    auth
            .userDetailsService(userDetailsService)
            .passwordEncoder(passwordEncoder());
}
Источник

5 ответов

Решение

Немного опоздал на вечеринку, но поскольку SpringFox полагается на Spring bean-компоненты для построения документации, мы можем легко манипулировать ею. Надеюсь, что это может помочь кому-то!

Зарегистрируйте это как боб

@Primary
@Bean
public ApiListingScanner addExtraOperations(ApiDescriptionReader apiDescriptionReader, ApiModelReader apiModelReader, DocumentationPluginsManager pluginsManager)
{
    return new FormLoginOperations(apiDescriptionReader, apiModelReader, pluginsManager);
}

Класс, используемый для добавления любой операции вручную:

import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpMethod;

import com.fasterxml.classmate.TypeResolver;
import com.google.common.collect.Multimap;

import springfox.documentation.builders.ApiListingBuilder;
import springfox.documentation.builders.OperationBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiDescription;
import springfox.documentation.service.ApiListing;
import springfox.documentation.service.Operation;
import springfox.documentation.spring.web.plugins.DocumentationPluginsManager;
import springfox.documentation.spring.web.readers.operation.CachingOperationNameGenerator;
import springfox.documentation.spring.web.scanners.ApiDescriptionReader;
import springfox.documentation.spring.web.scanners.ApiListingScanner;
import springfox.documentation.spring.web.scanners.ApiListingScanningContext;
import springfox.documentation.spring.web.scanners.ApiModelReader;

public class FormLoginOperations extends ApiListingScanner
{
    @Autowired
    private TypeResolver typeResolver;

    @Autowired
    public FormLoginOperations(ApiDescriptionReader apiDescriptionReader, ApiModelReader apiModelReader, DocumentationPluginsManager pluginsManager)
    {
        super(apiDescriptionReader, apiModelReader, pluginsManager);
    }

    @Override
    public Multimap<String, ApiListing> scan(ApiListingScanningContext context)
    {
        final Multimap<String, ApiListing> def = super.scan(context);

        final List<ApiDescription> apis = new LinkedList<>();

        final List<Operation> operations = new ArrayList<>();
        operations.add(new OperationBuilder(new CachingOperationNameGenerator())
            .method(HttpMethod.POST)
            .uniqueId("login")
            .parameters(Arrays.asList(new ParameterBuilder()
                .name("username")
                .description("The username")
                .parameterType("query")            
                .type(typeResolver.resolve(String.class))
                .modelRef(new ModelRef("string"))
                .build(), 
                new ParameterBuilder()
                .name("password")
                .description("The password")
                .parameterType("query")            
                .type(typeResolver.resolve(String.class))
                .modelRef(new ModelRef("string"))
                .build()))
            .summary("Log in") // 
            .notes("Here you can log in")
            .build());
        apis.add(new ApiDescription("/api/login/", "Authentication documentation", operations, false));

        def.put("authentication", new ApiListingBuilder(context.getDocumentationContext().getApiDescriptionOrdering())
            .apis(apis)
            .description("Custom authentication")
            .build());

        return def;
    }
}

Рендеринг Swagger JSON:

"/api/login/" : {
      "post" : {
        "summary" : "Log in",
        "description" : "Here you can log in",
        "operationId" : "loginUsingPOST",
        "parameters" : [ {
          "name" : "username",
          "in" : "query",
          "description" : "The username",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "password",
          "in" : "query",
          "description" : "The password",
          "required" : false,
          "type" : "string"
        } ]
      }
    }
Источник

Вы можете добавить в свой API поддельный метод входа и выхода из системы, просто чтобы сгенерировать документацию Swagger, он будет автоматически заменен фильтрами Spring Security.

@ApiOperation("Login.")
@PostMapping("/login")
public void fakeLogin(@ApiParam("User") @RequestParam String email, @ApiParam("Password") @RequestParam String password) {
    throw new IllegalStateException("This method shouldn't be called. It's implemented by Spring Security filters.");
}

@ApiOperation("Logout.")
@PostMapping("/logout")
public void fakeLogout() {
    throw new IllegalStateException("This method shouldn't be called. It's implemented by Spring Security filters.");
}
Источник

Просто добавив немного исправлений. Если вы хотите сделать настоящий POST-запрос (например, через HTML-страницу swagger-ui), вам нужно внести небольшие изменения в ответ Мортена.

Код Morten Haraldsen делает POST-запрос к / логину так:

http://<hostname>/api/login?username=<user>&password=<password>

Но если вы хотите сделать запрос POST, вам нужно передать тело, а не только параметры запроса. Чтобы это произошло, вам нужно добавить параметр с именем body и тип параметра body как это:

@Override
public Multimap<String, ApiListing> scan(ApiListingScanningContext context)
{
    final Multimap<String, ApiListing> def = super.scan(context);

    final List<ApiDescription> apis = new LinkedList<>();

    final List<Operation> operations = new ArrayList<>();
    operations.add(new OperationBuilder(new CachingOperationNameGenerator())
        .method(HttpMethod.POST)
        .uniqueId("login")
        .parameters(Arrays.asList(new ParameterBuilder()
            .name("body")
            .required(true)
            .description("The body of request")
            .parameterType("body")            
            .type(typeResolver.resolve(String.class))
            .modelRef(new ModelRef("string"))
            .build()))
        .summary("Log in") // 
        .notes("Here you can log in")
        .build());
    apis.add(new ApiDescription("/api/login/", "Authentication documentation", operations, false));

    def.put("authentication", new ApiListingBuilder(context.getDocumentationContext().getApiDescriptionOrdering())
        .apis(apis)
        .description("Custom authentication")
        .build());

    return def;
}

Теперь мы можем передать тело с помощью нашего запроса POST. Тело может быть JSON, например:

{"username":"admin","password":"admin"}

Источник

Вы можете использовать интерфейс, описывающий API аутентификации. Фактическая реализация обеспечивается Spring Security. (Это вариант ответа Итало, где вместо поддельной реализации используется интерфейс.)

/**
 * Authentication API specification for Swagger documentation and Code Generation.
 * Implemented by Spring Security.
 */
@Api("Authentication")
@RequestMapping(value = "/", produces = MediaType.APPLICATION_JSON_VALUE)
public interface AuthApi {
    /**
     * Implemented by Spring Security
     */
    @ApiOperation(value = "Login", notes = "Login with the given credentials.")
    @ApiResponses({@ApiResponse(code = 200, message = "", response = Authentication.class)})
    @RequestMapping(value = "/login", method = RequestMethod.POST)
    default void login(
        @RequestParam("username") String username,
        @RequestParam("password") String password
    ) {
        throw new IllegalStateException("Add Spring Security to handle authentication");
    }

    /**
     * Implemented by Spring Security
     */
    @ApiOperation(value = "Logout", notes = "Logout the current user.")
    @ApiResponses({@ApiResponse(code = 200, message = "")})
    @RequestMapping(value = "/logout", method = RequestMethod.POST)
    default void logout() {
        throw new IllegalStateException("Add Spring Security to handle authentication");
    }
}
Источник

Мое решение для springdoc-openapi:

      @Bean
public OpenAPI customOpenAPI() {
    return new OpenAPI()
            .components(new Components())
            .tags(List.of(
                    new Tag()
                            .name("Authentication")
                            .description("Login/logout controller")
            ))
            .path("/logout", new PathItem()
                    .post(new Operation()
                            .tags(List.of(
                                    "Authentication"
                            ))
                            .summary("Logout")
                            .description("Logout the current user.")
                            .operationId("logout")
                            .responses(new ApiResponses()
                                    .addApiResponse("200", new ApiResponse().description("OK"))
                            )
                    )
            )
            .path("/login", new PathItem()
                    .post(new Operation()
                            .tags(List.of(
                                    "Authentication"
                            ))
                            .summary("Login")
                            .description("Login with the given credentials.")
                            .operationId("login")
                            .parameters(List.of(
                                    new Parameter().name("username").in("query").required(true).schema(new Schema().type("string")),
                                    new Parameter().name("password").in("query").required(true).schema(new Schema().type("string"))
                            ))
                            .responses(new ApiResponses()
                                    .addApiResponse("200", new ApiResponse().description("OK"))
                            )
                    )
            );
}
Источник
Другие вопросы по тегам