Swagger

再通过可以解析这套规范工具就可以生成各种格式的接口文档以及在线接口调试页面通过自动文档的方式解决了接口文档更新不及时的问题。

Springfox

springfox-boot-starter.version3.0.0/springfox-boot-starter.version

3.0.0

dependencygroupIdio.springfox/groupIdartifactIdspringfox-boot-starter/artifactIdversion${springfox-boot-starter.version}/version

/dependency

dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-actuator/artifactId

/dependency

com.example.demo.controller;import

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties;

import

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;

import

org.springframework.boot.actuate.autoconfigure.web.server.ManagementPortType;

import

org.springframework.boot.actuate.endpoint.ExposableEndpoint;

import

org.springframework.boot.actuate.endpoint.web.*;

import

org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointsSupplier;

import

org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpointsSupplier;

import

org.springframework.boot.actuate.endpoint.web.servlet.WebMvcEndpointHandlerMapping;

import

org.springframework.context.annotation.Bean;

import

org.springframework.context.annotation.Configuration;

import

org.springframework.core.env.Environment;

import

org.springframework.util.StringUtils;

import

springfox.documentation.builders.ApiInfoBuilder;

import

springfox.documentation.builders.PathSelectors;

import

springfox.documentation.builders.RequestHandlerSelectors;

import

springfox.documentation.oas.annotations.EnableOpenApi;

import

springfox.documentation.service.ApiInfo;

import

springfox.documentation.service.Contact;

import

springfox.documentation.spi.DocumentationType;

import

springfox.documentation.spring.web.plugins.Docket;import

java.util.ArrayList;

Docket(DocumentationType.OAS_30).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage(com.example.demo.controller)).paths(PathSelectors.any()).build();return

docket;}//

ApiInfoBuilder().title(论坛系统API).description(论坛系统前后端分离API测试).contact(new

Contact(Test,https://hello.fprum.com,

1111111111qq.com)).version(1.0).build();return

apiInfo;}/***

WebMvcEndpointHandlerMappingwebEndpointServletHandlerMapping(WebEndpointsSupplier

webEndpointsSupplier,ServletEndpointsSupplier

servletEndpointsSupplier,ControllerEndpointsSupplier

controllerEndpointsSupplier,EndpointMediaTypes

endpointMediaTypes,

corsProperties,WebEndpointProperties

Environment

ArrayList();CollectionExposableWebEndpoint

webEndpoints

webEndpointsSupplier.getEndpoints();allEndpoints.addAll(webEndpoints);allEndpoints.addAll(servletEndpointsSupplier.getEndpoints());allEndpoints.addAll(controllerEndpointsSupplier.getEndpoints());String

basePath

webEndpointProperties.getBasePath();EndpointMapping

endpointMapping

EndpointMapping(basePath);boolean

this.shouldRegisterLinksMapping(webEndpointProperties,

new

WebMvcEndpointHandlerMapping(endpointMapping,

webEndpoints,endpointMediaTypes,corsProperties.toCorsConfiguration(),

newEndpointLinksResolver(allEndpoints,

basePath),shouldRegisterLinksMapping,

null);}private

shouldRegisterLinksMapping(WebEndpointPropertieswebEndpointProperties,

Environment

webEndpointProperties.getDiscovery().isEnabled()

(StringUtils.hasText(basePath)||ManagementPortType.get(environment).equals(ManagementPortType.DIFFERENT));}

}4.

启动程序在浏览器中输入网址http://127.0.0.1:58080/swagger-ui/index.html

可以正常运行并显示接口信息说明配置成功此时接口信息已经显示出来了可以分别针每个接口进测试具操作按页面指引即可。

点击“测试接口”出现如下图所示