swagger

安装配置

需要对JEECG工程中的spring-mvc.xml文件进行配置，将下面的代码放在文件的<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns=" "......>中，如下所示。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns=...>

<context:component-scan base-package="springfox"/>
<bean class="org.jeecgframework.core.swagger.SwaggerConfig" /> 
<mvc:resources mapping="/swagger/**" location="/swagger/" cache-period="31556926" />

</beans>

spring-mvc.xml中的注释

当不需要的时候，还可以暂时注释掉，以提高工程的运行性能，注释方式如下。

<!-- 通过在要注释的代码 两侧 加上此标识来完成注释
<context:component-scan base-package="springfox"/>
<bean class="org.jeecgframework.core.swagger.SwaggerConfig" /> 
<mvc:resources mapping="/swagger/**" location="/swagger/" cache-period="31556926" />
-->

所在位置

SwaggerConfig在JEECG工程src下的org.jeecgframework.core.swagger包中。

swagger的使用

访问地址

配置后需要访问http://ip:port/projectName/swagger-ui.html才能查看配置好的接口。比如我自己是在jeecg工程中使用的，所以swagger的访问地址为http://localhost:8080/jeecg/swagger/index.html；也有博客给出了这样的网址：http://localhost:8081/swagger-ui.html，这都取决于配置信息了。

各功能的使用

swagger注解的使用

补入这篇博客

@requestbody与@requestparam

补入这篇博客

与swaggerUI中输入参数的关联

补入这篇博客