Swagger
我們提供的服務(wù)有:成都網(wǎng)站制作、做網(wǎng)站、微信公眾號(hào)開(kāi)發(fā)、網(wǎng)站優(yōu)化、網(wǎng)站認(rèn)證、隰縣ssl等。為上1000家企事業(yè)單位解決了網(wǎng)站和推廣的問(wèn)題。提供周到的售前咨詢和貼心的售后服務(wù),是有科學(xué)管理、有技術(shù)的隰縣網(wǎng)站制作公司
Swagger是一種和語(yǔ)言無(wú)關(guān)的規(guī)范和框架,用于定義服務(wù)接口,主要用于描述RESTful的API。它專注于為API創(chuàng)建優(yōu)秀的文檔和客戶端庫(kù)。支持Swagger的API可以為API方法生成交互式的文檔,讓用戶可以通過(guò)以可視化的方式試驗(yàn),查看請(qǐng)求和響應(yīng)、頭文件和返回代碼,從而發(fā)現(xiàn)API的功能。
swagger用于定義API文檔。
好處:
SpringBoot嵌入SwaggerUI
步驟
1.jar包引入
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.2.2</version> <scope>compile</scope> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> <scope>compile</scope> </dependency>
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("訂單中心測(cè)試平臺(tái)").description("在這里你可以瀏覽項(xiàng)目所有接口,并提供相關(guān)測(cè)試工具") .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配置說(shuō)明
這里有一個(gè)需要注意的問(wèn)題,讓W(xué)ebConfig去繼承WebMvcAutoConfigurationAdapter而不是直接繼承WebMvcConfigurerAdapter,否則Swagger的頁(yè)面出不來(lái)。
@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頁(yè)面訪問(wèn)
http://localhost:8080/projectName/swagger-ui.html#!/
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持創(chuàng)新互聯(lián)。
新聞標(biāo)題:詳解如何在SpringBoot里使用SwaggerUI
當(dāng)前鏈接:http://muchs.cn/article30/phdcpo.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供品牌網(wǎng)站建設(shè)、網(wǎng)站營(yíng)銷、面包屑導(dǎo)航、、企業(yè)網(wǎng)站制作、網(wǎng)站制作
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)