com.github.chuanzh.doctool.modelHtml.ftl Maven / Gradle / Ivy

Go to download




model.html







 



　　　　 接口文档注释
	
	
		<#list interfaces as inter>
			
		
			序号
			接口名称
			接口作用
		
${inter["index"] !}
			${inter["name"] !}
			${inter["desc"] !}
		
	
	
	<#list services as service>
		
		${service["index"]!}. 方法名称:${service["title"]!} 
		请求参数列表:
		

		
			<#list service["request"] as request>
				
			
				序号
				上级参数
				参数名
				类型
				是否可为空
				说明
			

					${request.index!}
					${request.parent!}
					${request.name!}
					${request.type!}
					${request.isNull!}
					${request.desc!}
				
			
		
		
		

			
			响应参数列表:
			
				<#list service["response"] as response>
				
				
					序号
					上级参数		
					参数名
					类型
					说明
				

					${response.index!}
					${response.parent!}
					${response.name!}
					${response.type!}
					${response.desc!}
				
				
			
		

		回到顶部
		

		
	
				
	
　　错误编码定义


	
		
			错误编码
			错误说明
		
		
			1001
			缺少AppKey
		
		
			1002
			无效AppKey
		
		
			1003
			IP受限
		
		
			1004
			无权访问指定接口
		
		
			1005
			appKey已过期
		
		
			1006
			接口请求次数超限制
		
		
			1007
			无效接口方法名
		
		
			1008
			无效签名
		
		
			1009
			缺少接口方法名参数
		
		
			1010
			缺少必选参数
		
		
			1011
			业务逻辑错误
		
		
			1012
			服务超时

序号	接口名称	接口作用
${inter["index"] !}	${inter["name"] !}	${inter["desc"] !}

序号	上级参数	参数名	类型	是否可为空	说明
${request.index!}	${request.parent!}	${request.name!}	${request.type!}	${request.isNull!}	${request.desc!}

错误编码	错误说明
1001	缺少AppKey
1002	无效AppKey
1003	IP受限
1004	无权访问指定接口
1005	appKey已过期
1006	接口请求次数超限制
1007	无效接口方法名
1008	无效签名
1009	缺少接口方法名参数
1010	缺少必选参数
1011	业务逻辑错误
1012	服务超时