@API的注解都只是用于生成文档吗？

[eisldkw]

以下代码中 红色区域的 @API相关注解 都只是用于生成文档吗？

@Api(value = "LoginController", description = "登录控制器")
@Controller
public class LoginController extends BaseController{

@Autowired
private SessionDAO sessionDAO;

@Autowired
private OaNotifyService oaNotifyService;

@Autowired
private MailBoxService mailBoxService;


/**
* 管理登录
* @throws IOException
*/
@ApiOperation(notes = "login", httpMethod = "POST", value = "用户登录")
@ApiImplicitParams({@ApiImplicitParam(name = "username", value = "用户名", required = true, paramType = "query",dataType = "string"),
@ApiImplicitParam(name = "password", value = "密码", required = true, paramType = "query",dataType = "string"),
@ApiImplicitParam(name="mobileLogin",value = "接口标志",required = true, paramType = "query",dataType = "string")})
@RequestMapping(value = "${adminPath}/login")
public String login(HttpServletRequest request, HttpServletResponse response) throws IOException {
Principal principal = UserUtils.getPrincipal();

if (logger.isDebugEnabled()){
logger.debug("login, active session size: {}", sessionDAO.getActiveSessions(false).size());
}

[0大丸子0]

对，swagger这东西个人认为除了@API可用来表示接口外，其余的都是为你的接口添加注释。

[尘风-随手记]

这些注解是swagger的，是为了生成API文档，不影响业务执行

[KeepSayingNo]

不只是文档注释吧，还可以用来测试接口

[eisldkw]

引用 3 楼 KeepSayingNo 的回复:

不只是文档注释吧，还可以用来测试接口

非常感谢。请问，以上代码中红色区域的 @API 注解 是不是只用于生成帮助文档

[liuyh1024]

具体可以百度一下swagge注解的作用，像@API作用在类上，表示这个类是做什么的，像上面红色注解都是生成文档用的。

[明白畅达]

swagger的注解，写了之后登录swaggerui生成接口文档，包括你填写的参数，方便前后端对接测试

[a863922230]

这些都是swagger的注解和程序本身没有太大的关系，就是全部删除也没有啥关系。