Начало работы

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

compile 'io.github.yedaxia:japidocs:1.4.4'

DocsConfig config = new DocsConfig();
config.setProjectPath("your springboot project path"); // корневой путь проекта
config.setProjectName("ProjectName"); // название проекта
config.setApiVersion("V1.0");       // версия API
config.setDocsPath("your api docs path"); // целевой путь API-документации
config.setAutoGenerate(Boolean.TRUE);  // автоматическая генерация
Docs.buildHtmlDocs(config); // выполнение для генерации

/**
 * User API
 */
@RequestMapping("/api/user/")
@RestController
public class UserController {


    /**
     * Get User List
     * @param listForm
     */
    @RequestMapping(path = "list", method = {RequestMethod.GET,  RequestMethod.POST}  )
    public ApiResult<PageResult<UserVO>> list(UserListForm listForm){
        return null;
    }

    /**
     * Save User
     * @param userForm
     */
    @PostMapping(path = "save")
    public ApiResult<UserVO> saveUser(@RequestBody UserForm userForm){
        return null;
    }

    /**
     * Delete User
     * @param userId user id
     */
    @PostMapping("delete")
    public ApiResult deleteUser(@RequestParam Long userId){
        return null;
    }
}

// в @param
@param userId user id

// at FormBean
public class UserListForm extends PageForm{
    private Integer status; //user status
    private String name; //user name
}

{
  "id": "long //user id",
  "name": "string //user name",
  "phone": "long // user phone",
  "avatar": "string // user avatar url",
  "gender": "byte //use gender"
}

 /**
 * save user
 * @param userForm
 */
@PostMapping(path = "save")
public ApiResult<UserVO> saveUser(@RequestBody UserForm userForm){
    return null;
}

{
  "code": "int",
  "errMsg": "string",
  "data": {
    "userId": "string //user id",
    "userName": "string //user name",
    "friends": [
      {
        "userId": "string //user id",
        "userName": "string //user name"
      }
    ],
    "readBooks": [
      {
        "bookId": "long //book id",
        "bookName": "string //book name"
      }
    ],
    "isFollow": "boolean //is **Если вам не нравится тип *return*, вы также можете использовать @ApiDoc в JApiDoc для объявления типа ответа.** Вы можете обратиться к главе @ApiDoc ниже.

### 3. Api Java Beans должны быть в исходном коде

Мы знаем, что в байт-коде скомпилированного класса нет информации о комментариях. Чтобы JApiDcos работал лучше, ваш класс Form bean и класс возврата должны быть в исходном коде, иначе в сгенерированном документе будет отсутствовать информация описания. В любом случае, в версии 1.4.2 JApiDocs попытается проанализировать информацию о поле с помощью отражения, если не сможет найти исходный код (зависимый класс находится в jar-пакете).

# Расширенная конфигурация

## @ApiDoc

По умолчанию JApiDocs экспортирует только API, который объявляет @ApiDoc. Ранее мы сняли это ограничение, установив config.setAutoGenerate(Boolean.TRUE).

Если вы не хотите экспортировать все API, вы можете отключить autoGenerate и добавить @ApiDoc к классу Controller или методу API, чтобы определить, какой API необходимо экспортировать.

Давайте посмотрим, как работает @ApiDoc на методе API:

* result: тип возвращаемого объекта, он переопределит возвращаемый объект SpringBoot;
* url: URL запроса, расширенное поле, используется для поддержки проектов, отличных от SpringBoot;
* method: метод запроса, расширенное поле, используется для поддержки проектов, отличных от SpringBoot.

Пример:
```java
@ApiDoc(result = AdminVO.class, url = "/api/v1/admin/login2", method = "post")

@Ignore
public class UserController { 
 
}

@Ignore
@PostMapping("save")
public ApiResult saveUser(){
  return null;
}

public class UserForm{
   @Ignore
   private Byte gender;
}

config.addPlugin(new MarkdownDocPlugin());

docsConfig.setResourcePath("ваш новый путь к шаблону");

public class CustomPlugin implements IPluginSupport{
    
    @Override
    public void execute(List<ControllerNode> controllerNodeList){
        // do something you want
    }
}

 config.addPlugin(new CustomPlugin());