Swagger
我们提供的服务有:成都网站制作、做网站、微信公众号开发、网站优化、网站认证、隰县ssl等。为上1000家企事业单位解决了网站和推广的问题。提供周到的售前咨询和贴心的售后服务,是有科学管理、有技术的隰县网站制作公司
Swagger是一种和语言无关的规范和框架,用于定义服务接口,主要用于描述RESTful的API。它专注于为API创建优秀的文档和客户端库。支持Swagger的API可以为API方法生成交互式的文档,让用户可以通过以可视化的方式试验,查看请求和响应、头文件和返回代码,从而发现API的功能。
swagger用于定义API文档。
好处:
SpringBoot嵌入SwaggerUI
步骤
1.jar包引入
io.springfox springfox-swagger-ui 2.2.2 compile io.springfox springfox-swagger2 2.2.2 compile
2.基于SpringBoot配置SwaggerConfig
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket newsApi() { //return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().paths(PathSelectors.any()).build(); Docket docket = new Docket(DocumentationType.SWAGGER_2); docket.enable(true); docket.apiInfo(apiInfo()).select().paths(PathSelectors.any()).build(); return docket; } private ApiInfo apiInfo() { return new ApiInfoBuilder().title("订单中心测试平台").description("在这里你可以浏览项目所有接口,并提供相关测试工具") .termsOfServiceUrl("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?Open").contact("test") .license("China Red Star Licence Version 1.0").licenseUrl("#").version("1.0").build(); } }
3.WebConfig配置说明
这里有一个需要注意的问题,让WebConfig去继承WebMvcAutoConfigurationAdapter而不是直接继承WebMvcConfigurerAdapter,否则Swagger的页面出不来。
@Configuration @EnableWebMvc public class WebConfig extends WebMvcAutoConfigurationAdapter { @Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/**"); } @Bean public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() { return new PropertySourcesPlaceholderConfigurer(); } @Bean public Filter characterEncodingFilter() { CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter(); characterEncodingFilter.setEncoding("UTF-8"); characterEncodingFilter.setForceEncoding(true); return characterEncodingFilter; } @Bean public MappingJackson2HttpMessageConverter converter() { MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter(); return converter; } @Bean public ViewResolver getViewResolver() { InternalResourceViewResolver resolver = new InternalResourceViewResolver(); resolver.setViewClass(JstlView.class); resolver.setPrefix("/jsp"); resolver.setSuffix(".jsp"); return resolver; } @Bean public StandardServletMultipartResolver getStandardServletMultipartResolver() { return new StandardServletMultipartResolver(); } }
4.SwaggerUI页面访问
http://localhost:8080/projectName/swagger-ui.html#!/
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持创新互联。