JApiDocs API文档-超级好用

JApiDocs API文档

官网： https://japidocs.agilestudio.cn/

你还在使用Swagger2来生成API文档吗？那还不赶紧扔掉Swagger2，赶紧使用JApiDocs,与swagger-ui的界面比较起来简直不要太完美

搭建步骤

搭建步骤非常简单，仅仅只需要2步

• 导入依赖

  <dependency>
    <groupId>io.github.yedaxia</groupId>
    <artifactId>japidocs</artifactId>
    <version>1.4.4</version>
  </dependency>
  

• 配置生成API文档

  DocsConfig config = new DocsConfig();
  config.setProjectPath("your springboot project path"); // root project path 
  config.setProjectName("ProjectName"); // project name
  config.setApiVersion("V1.0");       // api version
  config.setDocsPath("your api docs path"); // api docs target path
  config.setAutoGenerate(Boolean.TRUE);  // auto generate 
  Docs.buildHtmlDocs(config); // execute to generate 
  

  在任意地方创建一个main()方法，运行以上代码，就可以生成API接口文档了， 是不是炒鸡简单啊