JAVA工具----自动化API文档APIFOX

news2024/11/24 16:17:42

前言：想必大家在后端开发的过程过，最烦的就是写接口文档了。然而如果是对接前写，就更加烦躁，可能之前写好的接口文档全都要改，还会占用大量的时间，一般的小团队也耗不起这样的费时。那么使用Swagger和侵入式注解这些方法，都需要我们在接口上打上注解，而且难免会有遗漏，而且过多的注解对我们的代码可读性来说很不友好；

简介：Apifox是广州瑞狐可以有限公司旗下平台，是Api文档、Api调试、Api Mock、Api自动测试一体化协作平台，是API设计/开发/测试工具，定位Postman+Swagger+Mock+JMeter。

一丶IDEA安装 Apifox Helper

进入File-Setting-Plugins，找到市场Marketplace，搜索Apifox Helper

如果下载失败，多尝试几次，有点儿慢。

下载完成后，这些应该是自动勾选；

/**
 * 微信公众号/订阅号开发
 */
@Slf4j
@Controller
@RequestMapping("/wechat")
public class WeChatController {
    @Autowired
    private WeChatService weChatService;
    /**
     * 由后端来进行授权操作（需要在微信页面打开）
     *
     * @param baseUrl 前端页面地址 用于授权完成后，后端重定向到前端页面
     * @param scope   应用授权作用域，此处为了模拟两种情况，进行传值:
     *                snsapi_base （不弹出授权页面，直接跳转，只能获取用户openid）
     *                snsapi_userinfo （弹出授权页面，可通过 openid 拿到昵称、性别、所在地。 即使在未关注的情况下，只要用户授权，也能获取其信息 ）
     * @return
     */
    @GetMapping(value = "/code")
    //"用户请求进行授权及获取信息", notes = "用户请求进行授权及获取信息"
    public String code(@RequestParam("baseUrl") String baseUrl, String scope) throws UnsupportedEncodingException {
        log.info("------ 用户请求进行授权及获取信息 ------");
        //通过code获取用户其信息
        String url = weChatService.getAuthCode(baseUrl, scope);
        return "redirect:" + url;
    }
}

我们代码中的@Param，@Link，@Return这些是标准的JavaDoc注释，这是JDK里面定义好的，全球通用。