Swagger UI 使用实例

时间:2025-03-17 19:34:42

类上依赖jar包:

		<dependency>
				<groupId></groupId>
				<artifactId>springfox-swagger2</artifactId>
				<version>2.4.0</version>
			</dependency>

			<dependency>
				<groupId></groupId>
				<artifactId>springfox-swagger-ui</artifactId>
				<version>2.4.0</version>
			</dependency>

			<dependency>
				<groupId></groupId>
				<artifactId>springfox-staticdocs</artifactId>
				<version>2.4.0</version>
			</dependency>

spring的配置文件中加入:

	<mvc:resources mapping="" location="classpath:/META-INF/resources/" />
	<mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/" />

类上所加注释:

@Api(value = "有效期规则定义-api", description = "有效期规则定义API")
@Controller
@RequestMapping(value="/validitRuleDefine")
public class ValiditRuleDefController {</span>


方法上所加注释:
	private static final String INSERTVALIDITRULE ="{\"startDate\":\"2016-07-20\",\"endDate\":\"2016-07-21\",\"expireTime\":\"2016-07-21\"}"; 
	/**
	 * 添加有效期规则定义
	 * @param request
	 * @return
	 */
	@ApiOperation(value = "新增有效规则定义", notes = "新增有效规则定义")
	@ApiResponses(value = { @ApiResponse(code = 200, message = "返回结果 -- state:0(成功),state:非0(失败)") })
	@RequestMapping(value="/insert",method=)
	@ResponseBody
	public Map<String,Object> insertRule(HttpServletRequest request, @ApiParam(value = INSERTVALIDITRULE)@RequestParam String json){
		int resultCode=Constant.CODE_SUCCESS0;
		String resultName="保存成功";
		Map<String,Object> mapData=new HashMap<String,Object>();
		ExpirySet expirySet = new ExpirySet();
		try {
			expirySet = (ExpirySet) (json, );
			(0);
		} catch (Exception e) {
			();
			(" error", e);
			return (Constant.CODE_CLIENT_ERROR, "客户端数据异常", mapData);
		}。。。。。。


页面效果如下