springboot (08) использует japidocs для автоматического создания интерфейсных документов

В приложении Spring Boot вы можете использовать JApiDocs (генератор документации Java API) для автоматического создания документации интерфейса. JApiDocs может генерировать документацию, сканируя код и создавая HTML-документацию. Вот шаги для создания документации интерфейса с использованием JApiDocs:

Springboot использует japidocs (1)

1. Добавьте в файл pom.xml следующие зависимости:

<dependency>
    <groupId>com.github.houbb</groupId>
    <artifactId>japidocs</artifactId>
    <version>1.6.1</version>
</dependency>

2. Добавьте аннотации к классу запуска приложения Spring Boot @EnableJapidocs.

@SpringBootApplication
@EnableJapidocs
public class SpringbootApplication {
    
    

    public static void main(String[] args) {
    
    
        SpringApplication.run(SpringbootApplication.class, args);
    }

}

3. Добавьте аннотации JApiDocs в классы или методы вашего контроллера. Например:

@RestController
@RequestMapping("/api")
public class ApiController {
    
    

    /**
     * 查询用户
     *
     * @param id 用户ID
     * @return 用户信息
     */
    @JApiDocsMethod(name = "查询用户", author = "John", version = "1.0.0")
    @GetMapping("/user/{id}")
    public User getUser(@PathVariable Long id) {
    
    
        // 查询用户信息
        User user = userService.getUserById(id);
        return user;
    }

}

доступ

Запустите приложение и посетите http://localhost:8080/japidocs/index.html, вы увидите документацию по интерфейсу, которая создается автоматически.

Создание документации интерфейса с помощью JApiDocs так же просто, как добавление зависимостей и аннотаций. Это удобный и быстрый способ создания и поддержки документации по интерфейсу.

Springboot использует japidocs (2)

1. Добавьте зависимости

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

2. Примечания к уровню контроллера

	/**
     * 发送邮件
     * @param title 标题 （字符串）
     * @param text 主题内容（字符串）
     * @param receive 邮件的接受人（字符串）
     */

Три, используйте

Запустите основной метод в тестовом классе для создания автономных HTML-документов.При локальном запуске проекта его можно напрямую записать как метод в классе запуска Springboot.

public static void main(String[] args) {
    
    
      DocsConfig config = new DocsConfig();
        config.setProjectPath("D:\\workSpace\\idea\\sbtest1"); // root project path
        config.setProjectName("项目名称"); // project name
        config.setApiVersion("V1.0");       // api version
        config.setDocsPath("D:\\workSpace\\idea\\sbtest1\\apidoc"); // api docs target path
        config.setAutoGenerate(Boolean.TRUE);  // auto generate
        Docs.buildHtmlDocs(config); // execute to generate
}

Где setProjectPath — корневой каталог проекта, setDocsPath — каталог создания документа.