簡介

  Lkadoc是一款開源的介面文件自動生成工具，基於SpringBoot平臺，擁有非常強大的介面文件管理功能。為解決Java後臺開發人員編寫介面文件、除錯介面而生。同時提供了簡潔、大氣、功能豐富的介面文件UI操作介面，方便後端與前端之間的介面對接。

願景

  我們願成為java開發人員最好的基友，從手動編寫介面文件的痛苦中解救出來，丟棄難用的Postman，工作效率從此翻倍，不再加班，有更多的時間陪伴家人。

pom.xml檔案中引入lkadoc的依賴

<!--Lkadoc包-->
<dependency>
    <groupId>com.github.liukaitydn</groupId>
    <artifactId>lkadoc-api</artifactId>
    <version>1.4.0</version>
</dependency>
<dependency>
    <groupId>com.github.liukaitydn</groupId>
    <artifactId>lkadoc-annotations</artifactId>
    <version>1.4.0</version>
</dependency>
 

在LkadocDemo專案啟動類LkadocDemoApplication上加上@LKADocument註解

/**
 * 說明：啟動類
 * 作者：FH Admin
 * from：fhadmin.cn
 */
@LKADocument(basePackages="org.fh.controller")
@SpringBootApplication
public class LkadocDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(LkadocDemoApplication.class, args);
    }
}
 

在org.fh.controller包下面準備一個使用者登入註冊模組類-LKADemoController

/**
 * 說明：使用者登入註冊
 * 作者：FH Admin
 * from：fhadmin.cn
 */
@LKAType(value="使用者登入註冊模組")
@RestController
@RequestMapping("user")
public class LKADemoController {
 
    @LKAMethod(value="登入")
    @LKAParam(names= {"name","pwd"},values= {"使用者名稱","密碼"})
    @LKARespose(names= {"code","msg"},values= {"狀態碼","訊息"})
    @PostMapping("login")
    public Map<String,Object> login(String name, String pwd) {
        Map<String,Object> map = new HashMap<>();
        map.put("code",200);
        map.put("msg","登入成功，歡迎"+name+"光臨本系統");
        return map;
    }
}
 

啟動專案，開啟瀏覽器，輸入地址 http://127.0.0.1:8080/lkadoc.html