jizcode.api.doc

Class ApiDocController

java.lang.Object

jizcode.api.doc.ApiDocController

@Controller
 @RequestMapping(value="/")
public class ApiDocController
extends Object

文档Controller，通过这里可以查看各个模块的服务接口文档

Constructor Summary

Constructors

Constructor and Description
ApiDocController()

Method Summary

Modifier and Type	Method and Description
void	docForModule(String product, String system, String module, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	docForServiceOrAction(String product, String system, String module, String service, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	docForSystem(String product, String system, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiDocController

public ApiDocController()

Method Detail

docForSystem

@RequestMapping(value="/doc/api/{product}/{system}",
                method=GET)
public void docForSystem(@PathVariable(value="product")
                                                                                                            String product,
                                                                                                            @PathVariable(value="system")
                                                                                                            String system,
                                                                                                            javax.servlet.http.HttpServletRequest request,
                                                                                                            javax.servlet.http.HttpServletResponse response)
                                                                                                     throws Exception

Throws:

Exception

docForModule

@RequestMapping(value="/doc/api/{product}/{system}/{module}",
                method=GET)
public void docForModule(@PathVariable(value="product")
                                                                                                                     String product,
                                                                                                                     @PathVariable(value="system")
                                                                                                                     String system,
                                                                                                                     @PathVariable(value="module")
                                                                                                                     String module,
                                                                                                                     javax.servlet.http.HttpServletRequest request,
                                                                                                                     javax.servlet.http.HttpServletResponse response)
                                                                                                              throws Exception

Throws:

Exception

docForServiceOrAction

@RequestMapping(value="/doc/api/{product}/{system}/{module}/{service:[^\\.]+}",
                method=GET)
public void docForServiceOrAction(@PathVariable(value="product")
                                                                                                                                                String product,
                                                                                                                                                @PathVariable(value="system")
                                                                                                                                                String system,
                                                                                                                                                @PathVariable(value="module")
                                                                                                                                                String module,
                                                                                                                                                @PathVariable(value="service")
                                                                                                                                                String service,
                                                                                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                                                                                javax.servlet.http.HttpServletResponse response)
                                                                                                                                         throws Exception

Throws:

Exception