1. Описание версии
- пружинная загрузка: 2.1.5.РЕЛИЗ
- swagger:2.9.2
Добавьте зависимости чванства:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
2. Примеры
2.1 чванливая конфигурация
Напишите класс конфигурации swagger и непосредственно напишите соответствующие настройки для простоты.Проект может внедрить swagger, прочитав информацию файла конфигурации.
@EnableSwagger2
@Configuration
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("me.wubc"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("编程头条API文档")
.description("编程头条API文档")
.contact(new Contact("无编程", "http://wube.me", "xx@gmail.com"))
.termsOfServiceUrl("http://wube.me")
.version("1.0")
.build();
2.2 Написание контроллера
@Api("登录接口")
@RestController
@RequestMapping("api/v1/login")
public class LoginController {
@Autowired
private ApUserLoginService apUserLoginService;
@ApiOperation("登录接口")
@PostMapping("loginAuth")
public ResponseResult login(@RequestBody User user) {
return apUserLoginService.loginAuth(user);
}
}
Кратко объясните:
- @API: указывает на открытый API, который можно использовать для краткого описания функций API.
- @ApiOperation указывает, для чего используется этот интерфейс, а также может описывать роль операции через значение и примечания, а ответ описывает тип объекта, возвращаемого запросом при нормальных обстоятельствах.
Для получения дополнительных аннотаций, пожалуйста, обратитесь к официальной документации:docs.swagger.IO/swagger-eat или…
3. Проблемы
При открытии ip:port/swagger-ui.html возникает ошибка 404. В настоящее время нам нужно только изменить класс SwaggerConfig, который мы только что написали: наследованиеWebMvcConfigurationSupport, затем перепишитеметод addResourceHandlers, пример следующий:
public class SwaggerConfig extends WebMvcConfigurationSupport {
// 忽略已有的代码
...
//重写这个方法
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
В-четвертых, конец
Наконец, снова запустите проект, просто ip:{port}/swagger-ui.html. Обратите внимание, что если вы настраиваете контекст, вам нужно изменить адрес на: ip:{port}/{context}/swagger-ui. HTML
сделать небольшое объявление
Приглашаю всех обратить внимание на мой публичный номер:Бэкэнд Эссе
А также личный блог:wubc.me