本篇文章记录怎么给我们的后端项目整一个好用的接口文档
这个东西好像叫什么swagger吧
1. 依赖引入：
<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId></dependency>
2. 配置类编写
/*** 配置类，注册web层相关组件*/
@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {/*** 通过knife4j生成接口文档* @return*/@Beanpublic Docket docket() {ApiInfo apiInfo = new ApiInfoBuilder().title("后端接口文档").version("1.0").description("后端接口文档").build();Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).select().apis(RequestHandlerSelectors.basePackage("com.game.server.controller"))//com.codehome.server.controller是我的controller包的地址哦.paths(PathSelectors.any()).build();return docket;}/*** 设置静态资源映射* @param registry*/protected void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");}/*** 消息转换器*/protected void extendMessageConverters(List<HttpMessageConverter<?>> converters){log.info("开始扩展消息转换器");MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();converter.setObjectMapper(new JacksonObjectMapper());converters.add(0,converter);}
}
.apis(RequestHandlerSelectors.basePackage(“com.game.server.controller”))中，
com.game.server.controller是你自己的controller的包路径
3. 启动
启动项目即可
4. 查看接口文档
这个接口文档就会展示controller包里对应controller类的接口路由信息：
同时这个接口文档也很方便，方便测试什么的：
总之就是很方便的。
大概就是这样了。
