一、运行一次系统把项目最新全量api自动维护起来。我们来看看这个神奇的过程。
1、在gitee 下载 torna 作为api管理平台展示torna: 企业接口文档解决方案,目标是让文档管理变得更加方便、快捷。Torna采用团队协作的方式管理和维护项目API文档,将不同形式的文档纳入进来,形成一个统一的维护方式。
2、按照torna平台安装环境提示,安装运行torna
1、创建空间,界面效果如:
2、创建项目
3、创建模块,我们可以一个项目对应一个模块,项目中的模块按分类自动设置
4、 torna库,与api_auto库module表建立映射关系
查询torna库,module表
5、项目集成操作
1、项目pom中引入
<dependency> <groupId>com.auto.api</groupId> <artifactId>auto-api-http</artifactId> <version>0.0.1-RELEASE</version> </dependency>
2、application.properties 配置文件配置
#是否进行api解析 auto.api.mapping=true #是否使用mock数据 auto.api.mock=true
3、启动类增加 扫包路径 "com.auto.api"
4、配置文件注入bean
/**
* 配置文件
*/
@ConfigurationProperties(prefix = AutoApiProperties.AUTO_API_PREFIX)
public class AutoApiProperties {
public static final String AUTO_API_PREFIX = "auto.api";
/**
* 是否开启自动API
*/
public static final String OPEN_MAPPING = AUTO_API_PREFIX + ".mapping";
/**
* 是否开启自动API
*/
public static final String OPEN_MOCK = AUTO_API_PREFIX + ".mock";
private Boolean mapping = false;
/**
* 是否mock数据返回结果
*/
private Boolean mock = false;
public void setMapping(Boolean mapping) {
this.mapping = mapping;
}
public Boolean getMapping() {
return mapping;
}
public void setMock(Boolean mock) {
this.mock = mock;
}
public Boolean getMock() {
return mock;
}
}
5、bean注入配置
@Configuration
@EnableConfigurationProperties(AutoApiProperties.class)
@ConditionalOnProperty(value = AutoApiProperties.OPEN_MAPPING, havingValue = "true", matchIfMissing = false)
public class AutoApiConfiguration {
private AutoApiProperties autoApiProperties;
public AutoApiConfiguration(AutoApiProperties autoApiProperties) {
this.autoApiProperties = autoApiProperties;
}
@Bean
@ConditionalOnProperty(value = AutoApiProperties.OPEN_MOCK, havingValue = "true", matchIfMissing = false)
public FilterRegistrationBean mockFilter() {
FilterRegistrationBean mockFilter = new FilterRegistrationBean(new MockFilter());
List<String> urlPatterns = Lists.newArrayList();
urlPatterns.add("/*");
mockFilter.setUrlPatterns(urlPatterns);
return mockFilter;
}
@Bean
@Order(-100)
@ConditionalOnProperty(value = AutoApiProperties.OPEN_MAPPING, havingValue = "true", matchIfMissing = false)
public MappingInitListener mappingInitListener() {
return new MappingInitListener();
}
}
6、启动auto-api admin-server项目
7、再次运行torna项目,项目全量自动化解析效果图。