<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <!--api文檔  begin-->
            <plugin>
                <groupId>com.github.shalousun</groupId>
                <artifactId>smart-doc-maven-plugin</artifactId>
                <version>2.3.5</version>
                <configuration>
                    <!--指定生成文檔的使用的配置文件-->
                    <configFile>${basedir}/src/main/resources/smart-doc.json</configFile>
                </configuration>
                <executions>
                    <execution>
                        <!--如果不需要在執(zhí)行編譯時啟動smart-doc，則將phase注釋掉-->
                         <phase>compile</phase>
                        <goals>
                            <goal>html</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <!--api文檔  end-->
        </plugins>
    </build>

/**
 * 用戶控制器
 * @Author: pzj
 * @Date: 2025/6/12 18:59
 **/
@RestController
@RequestMapping("/users")
public class UserController {
    /**
     * 獲取用戶詳情
     * @param id 用戶ID
     * @return 返回用戶對象
     */
    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        return new User(id, "張三");
    }
    /**
     * 創(chuàng)建新用戶
     * @param user 用戶實(shí)體
     * @return 創(chuàng)建結(jié)果
     */
    @PostMapping("/add")
    public String createUser(@RequestBody User user) {
        System.out.println(user);
        return "創(chuàng)建成功";
    }
}

/**
 * 用戶實(shí)體類
 *
 * @Author: pzj
 * @Date: 2025/6/12 19:00
 *
 **/
public class User implements Serializable {
    /**
     * 主鍵
     */
    private Long id;
    /**
     * 用戶名
     */
    private String userName;
    public User(Long id, String userName) {
        this.id = id;
        this.userName = userName;
    }
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getUserName() {
        return userName;
    }
    public void setUserName(String userName) {
        this.userName = userName;
    }
}

{
  //指定后端服務(wù)訪問地址,
  "serverUrl": "http://127.0.0.1:8090",
  //指定文檔的輸出路徑，生成到項(xiàng)目靜態(tài)文件目錄下，隨項(xiàng)目啟動可以查看,
  "outPath": "src/main/resources/static/doc/api",
  //是否開啟嚴(yán)格模式,
  "isStrict": false,
  //是否將文檔合并到一個文件中,
  "allInOne": true,
  //是否創(chuàng)建可以測試的html頁面,
  "createDebugPage": true,
  //controller包過濾（換成你的路徑）,
  "packageFilters": "com.example.smartdoc.controller",
  //基于highlight.js的代碼高設(shè)置,
  "style": "xt256",
  //配置自己的項(xiàng)目名稱,
  "projectName": "smart-doc文檔",
  //是否顯示接口作者名稱,
  "showAuthor": false,
  //自定義設(shè)置輸出文檔名稱,
  "allInOneDocFileName": "index.html",
  //文檔變更記錄，非必須,
  "revisionLogs": [
    {
      //文檔版本號,
      "version": "1.0",
      //文檔修訂時間,
      "revisionTime": "2020-12-31 10:30",
      //變更操作狀態(tài)，一般為：創(chuàng)建、更新等,
      "status": "update",
      //文檔變更作者,
      "author": "peng_zj",
      //變更描述,
      "remarks": "修改了XXXX功能"
    }
  ]
}