Spring MVC使用说明

针对Spring framework的web服务框架,wrdoclet主要是利用注解来识别服务接口以及参数。比如@RequestMapping,@ResponseBody,@Controller等。因为Spring framework注解较多,目前wrdoclet还有一部分注解没有支持,比如@SessionAttributes, @ModelAttribute等。

web服务框架通常涉及登录,并且通过interceptor来实现登录token验证的比较多。为了能在接口文档中标示接口是否需要用户登录,wrdoclet可以尝试分析mvc的配置文件,从而确定哪些接口需要登录后才能使用。

 <mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/**" />
        <mvc:exclude-mapping path="/*/getgender/*"/>

        <bean class="net.winroad.Interceptor.LoginInterceptor">
            <property name="excludedUrls">
                <list>
                    <value>/class/list</value>
                    <value>/student/login</value>
                </list>
            </property>
        </bean>
    </mvc:interceptor>
</mvc:interceptors>

wrdoclet在运行过程中无法知道mvc的配置文件的具体地址,因此需要在执行时明确传入该配置文件的绝对地址,以及用于识别那些无需登录的URL地址的XPATH。下面就是demo中生成文档时所使用的参数。

"-springcontextconfigpath",
"D:/Git/wrdoclet/wrdoclet-demosite/src/main/webapp/WEB-INF/mvc-dispatcher-servlet.xml",
"-excludedurlsxpath",
"//:beans/mvc:interceptors/mvc:interceptor/:bean/:property/:list/:value",                

results matching ""

    No results matching ""