API自動生成工具
阿新 • • 發佈：2019-01-26
配置哪些API自動生成文件
import com.google.common.base.Predicate;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import static com.google.common.base.Predicates.or;
import static springfox.documentation.builders.PathSelectors.regex;
……@Configuration
public class SwaggerConfig
{
@Bean
public Docket
swaggerSpringMvcPlugin() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.paths(paths())
.build();
}
private Predicate<String>
paths() {
return or(regex("/accounts.*"));
}
}
|
傳統SpringMVC Web專案中使用Swagger
在傳統SpringMVC Web專案中使用Swagger步驟與Spring Boot中基本一致
新增依賴
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
|
對外暴露Swagger UI訪問地址
Swagger UI靜態檔案採用webjar的形式釋出，需要手動對映靜態資源路徑。
<mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/" />
|
若SpringMVC匹配所有請求，還需在`web.xml`中單獨對映`swagger-ui.html`路徑。
<servlet-mapping>
<servlet-name>default</servlet-name>
<url-pattern>/swagger-ui.html</url-pattern>
</servlet-mapping>
|
配置哪些API自動生成文件，僅需將上文中的`SwaggerConfig類`配置到Spring中。
<bean class="com.equals.swagger.demo.configuration.
SwaggerConfig" />
|