cn.mapway.document.resource.help.html Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-tools-doc Show documentation
Show all versions of api-tools-doc Show documentation
auto gen doc from api with ui
The newest version!
Mapway文档生成器使用说明
文档生成器说明
本文档生成器提供一个Web Servlet 和 辅助类 DocHelper.
Web Servlet 配置说明
在web.xml中做如下配置
<servlet>
<servlet-name>MapwayDocServlet</servlet-name>
<servlet-class>cn.mapway.document.servlet.MapwayDocServlet</servlet-class>
<init-param>
<param-name>author</param-name>
<param-value>[email protected]</param-value>
</init-param>
<init-param>
<param-name>title</param-name>
<param-value>测试接口</param-value>
</init-param>
<init-param>
<param-name>subtitle</param-name>
<param-value>副标题</param-value>
</init-param>
<init-param>
<param-name>basePath</param-name>
<param-value>http://localhost:8080/mapway-doc-ui/</param-value>
</init-param>
<init-param>
<!--需要扫描的API包-->
<param-name>scanPackages</param-name>
<param-value>cn.mapway.document.test</param-value>
</init-param>
<init-param>
<!--ANT 脚本安装目录-->
<param-name>antHome</param-name>
<param-value>c:\ant</param-value>
</init-param>
<init-param>
<!--客户端连接器包名-->
<param-name>connectorPackageName</param-name>
<param-value>cn.mapway.api.connector</param-value>
</init-param>
<init-param>
<!--客户端连接器类名-->
<param-name>connectorClassName</param-name>
<param-value>SolaApi</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<!--Servlet 映射-->
<servlet-mapping>
<servlet-name>MapwayDocServlet</servlet-name>
<url-pattern>/doc/*</url-pattern>
</servlet-mapping>
©2016 mapway.cn