«Golden Nuggets Said» может предоставлять документы интерфейса API, не надевая чулок (чванство)

Java
«Golden Nuggets Said» может предоставлять документы интерфейса API, не надевая чулок (чванство)

Наггетс сказал в прошлый разИспользуйте аннотации вместо if-else, чтобы сделать ваш код более элегантным!Создал новый проектpig-strategyЧтобы рассказать о режиме стратегии, добавьте аннотацию развития.

Позиции двух людей в «Тридцати только» не отличаются и не незаменимы.Так же, как автомобили, бегущие по дороге, кажется, что у всех есть номерной знак, но если вы не зарабатываете бензин, вы даже не имеет права выходить на дорогу.

Здесь просто сделайте практическую запись операции, подробности см. в официальной документации.

Позже я хочу комментировать и писать меньше, можно? Документы интерфейса, которые мы часто используемswagger-uiГомофонические «чулки брата», каждый раз, когда вы добавляете чванство, вам нужно добавлять зависимости maven, добавлять конфигурацию конфигурации, добавлять введение класса сущности @API и добавлять его в контроллер. Если мы хотим сэкономить время и нервы, то мы нашли ненавязчивую полку с открытым исходным кодом, которая решает наши насущные потребности.

JApiDocs — это готовый инструмент для создания документации SpringBoot API без дополнительных аннотаций.Мы пишем и поддерживаем документы API.Для бэкенд-программистов документы API станут незаменимым коммуникационным интерфейсом при совместной работе с интерфейсом и сервером. Поскольку это неизбежно, найдите способ решить эту проблему.

Упражняться

Шаг 1: Добавьте зависимости

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

Шаг 2: Настройте параметры

Вы можете запустить следующий код из любой основной записи:

    @Test
    void test_japidocs() {
        DocsConfig config = new DocsConfig();
        // 项目根目录
        config.setProjectPath("E:\\pig-study\\pig-strategy");
        // 项目名称
        config.setProjectName("pig-strategy");
        // 声明该API的版本
        config.setApiVersion("V1.0");
        // 生成API 文档所在目录
        config.setDocsPath("E:\\pig-study\\pig-strategy\\japidocs");
        // 配置自动生成
        config.setAutoGenerate(Boolean.TRUE);
        // 添加插件（MarkdownDoc）
        config.addPlugin(new MarkdownDocPlugin());
        // 执行生成文档
        Docs.buildHtmlDocs(config);

    }

Если не случайно, после выполнения приведенного выше кода вы сможете увидеть сгенерированную документацию в сконфигурированном каталоге.

исключение VoidType

java.lang.ClassCastException: com.github.javaparser.ast.type.VoidType cannot be cast to com.github.javaparser.ast.type.ClassOrInterfaceType
  • задача решена:

Это связано с тем, что метод интерфейса не объявляет возвращаемые параметры (void) Теоретически запросы должны иметь возвращаемые значения. Если он не объявлен возвращаемым типом, вы можете передать@ApiDocуказать тип возвращаемого значения.issues80

пример: добавлен исходный код @ApiDoc(Result.class)

    /**
     * 获取图片
     */
    @ApiDoc(Result.class)
    @GetMapping("get-image")
    public void getImage() {

    }

Практический эффект

  • html

  • markdown

Короче говоря, аннотации все еще должны быть написаны, и только несколько аннотаций могут быть сопоставлены. Практика и опыт.

использованная литература

свинья4cloud:pig4cloud.com/

Официальная документация:Установите параметр o API.agile studio.capable/#/this-capable/?ID…

Адрес склада:GitHub.com/Y Eda/J AP…

Китайский документ:japidocs.agilestudio.cn/#/zh-cn/

Адрес данных:Tickets.WeChat.QQ.com/Yes/HR GRE Questions Zn…

Категории