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接口文檔了， 是不是炒雞簡單啊