Автор оригинала: Sallo Szrajbman.
1. введение
В этом коротком руководстве мы рассмотрим, как настроить пользовательский интерфейс Swagger для включения веб-маркера JSON (JWT) при вызове нашего API.
2. Зависимости Maven
В этом примере мы будем использовать springfox-boot-starter , который включает в себя все необходимые зависимости для начала работы с Swagger и пользовательским интерфейсом Swagger. Давайте добавим его в ваш pom.xml файл:
org.springframework.boot spring-boot-starter-web io.springfox springfox-boot-starter 3.0.0
3. Конфигурация чванства
Во-первых, нам нужно определить ваш ключ Api , чтобы включить JWT в качестве заголовка авторизации:
private ApiKey apiKey() {
return new ApiKey("JWT", "Authorization", "header");
}Далее, давайте настроим JWT Контекст безопасности с глобальной Областью авторизации :
private SecurityContext securityContext() {
return SecurityContext.builder().securityReferences(defaultAuth()).build();
}
private List defaultAuth() {
AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
authorizationScopes[0] = authorizationScope;
return Arrays.asList(new SecurityReference("JWT", authorizationScopes));
} А затем мы настраиваем наш API Docket bean для включения информации об API, контекстов безопасности и схем безопасности:
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.securityContexts(Arrays.asList(securityContext()))
.securitySchemes(Arrays.asList(apiKey()))
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfo(
"My REST API",
"Some custom description of API.",
"1.0",
"Terms of service",
new Contact("Sallo Szrajbman", "www.baeldung.com", "[email protected]"),
"License of API",
"API license URL",
Collections.emptyList());
}4. Контроллер ОТДЫХА
В нашем Clients RestController давайте напишем простую get Clients конечную точку , чтобы вернуть список клиентов:
@RestController(value = "/clients")
@Api( tags = "Clients")
public class ClientsRestController {
@ApiOperation(value = "This method is used to get the clients.")
@GetMapping
public List getClients() {
return Arrays.asList("First Client", "Second Client");
}
} 5. Чванливый ПОЛЬЗОВАТЕЛЬСКИЙ ИНТЕРФЕЙС
Теперь, когда мы запускаем наше приложение, мы можем получить доступ к пользовательскому интерфейсу Swagger в http://localhost:8080/swagger-ui/ URL.
Вот посмотрите на пользовательский интерфейс Swagger с кнопкой Authorize :
Когда мы нажмем кнопку Authorize , Swagger UI запросит JWT.
Нам просто нужно ввести ваш токен и нажать на Authorize , и с этого момента все запросы, сделанные к нашему API, будут автоматически содержать токен в заголовках HTTP:
6. Запрос API с помощью JWT
При отправке запроса в наш API мы видим, что есть заголовок “Авторизация” со значением нашего токена:
7. Заключение
В этой статье мы увидели, как пользовательский интерфейс Swagger предоставляет пользовательские конфигурации для настройки JWT, что может быть полезно при работе с авторизацией нашего приложения. После авторизации в пользовательском интерфейсе Swagger все запросы автоматически будут включать наш JWT.
Исходный код в этой статье доступен на GitHub .