java中利用smart-doc生成接口文档(很快很方便,关键是轻巧,好用)

如何利用smart-doc生成接口文档?想必很多在使用springboot项目的小伙伴的朋友们都知道swagger是个硬伤 但是真的没办法的 真的 我推荐使用的是smart-doc文档 真的很方便 也很好的使用!

说多了都是装逼 那么我们来了解一波 哈哈哈  我的很详细 保证你不会走弯路 okay!

首先映入jar包 我推荐使用我的jar包:直接复制过去;



    com.github.shalousun
    smart-doc
    1.6

*************************************************************************************

下面只要是在@controller中的注释都会生成.md文件

需要启动下测试类:

/**
 * 测试生成文档
 */
@Test
public void testBuilderControllersApiSimple() {
    ApiConfig config = new ApiConfig();
    //服务地址
    config.setServerUrl("http://192.168.1.250:8082");//接口地址:
    //生成到一个文档
    config.setAllInOne(true);
    //采用严格模式
    config.isStrict();
    //文档输出路径
    config.setOutPath("/E:/md/");//这里的话 需要自己定义下文件的地址哈
    ApiDocBuilder.builderControllersApi(config);
    //将生成的文档输出到/Users/dujf/Downloads/md目录下,严格模式下api-doc会检测Controller的接口注释
}

到了这一步就好啦哈 全部都会把接口中的注释变成文档 okay 蟹蟹大家阅读 不懂的话 可以问我 2211743862 加我我给你说

 

 

你可能感兴趣的:(java入坑)