Слияние кода завершено, страница обновится автоматически
JDoc
JDoc — это генератор документации по интерфейсам, разработанный на основе JAVA. Он предназначен для использования с основными веб-фреймворками и требует минимальной конфигурации для создания документации. В основе лежит анализ комментариев в коде, что позволяет избежать вмешательства в исходный проект. Это решает проблемы с созданием и обновлением документации по интерфейсам во время разработки, а также значительно повышает эффективность совместной работы между фронтендом и бэкендом.
Maven-зависимости:
<dependency>
<groupId>com.jdocapi</groupId>
<artifactId>jdoc</artifactId>
<version>{{version}}</version>
</dependency>
Конфигурация JDoc: файл конфигурации JDoc должен быть помещён в папку resource с именем jdoc.properties. Пример конфигурации:
java.source=src/test/java
package.name=com.nmtx.test
parser.name=jfinal
out.path=test.html
parser.formater=html
api.prefix=/api
Пример конфигурации контроллера:
package com.nmtx.jfinal.controller;
import com.jfinal.aop.Before;
import com.jfinal.core.Controller;
import com.jfinal.ext.interceptor.POST;
import com.nmtx.jfinal.common.MessageResp;
import com.nmtx.jfinal.model.User;
/**
* Модуль пользователя
*
* @author lianghao
*
* 2017年3月27日
*/
public class UserController extends Controller {
/**
* Функция для добавления пользователя
* @title Добавление пользователя
* @param username|Имя пользователя|String|Обязательный
* @param password|Пароль|String|Обязательный
* @param createTime|Время создания|Date|Обязательный
*/
@Before(POST.class)
public void add() {
MessageResp<String> resp = new MessageResp<String>();
resp.setData("");
resp.setCode("100000");
resp.setMessage("Добавление успешно");
renderJson(resp);
}
/**
* Функция для удаления пользователя
* @title Удаление пользователя
* @respBody {"code":"100000","data":"","message":"Удаление успешно"}
*/
public void delete(){
MessageResp<String> resp = new MessageResp<String>();
resp.setData("");
resp.setCode("100000");
resp.setMessage("Удаление успешно");
renderJson(resp);
}
/**
* Функция поиска пользователя по идентификатору
* @title Поиск пользователя по ID
* @respParam username|Имя пользователя|String|Обязательный
* @respParam password|Пароль|String|Обязательный
* @respBody {"code":"100000","data":{"password":"123456","username":"13811111111"},"message":"Получение успешно"}
*/
public void getUserById(){
MessageResp<User> resp = new MessageResp<User>();
User user = new User();
user.put("username","13811111111");
user.put("password","123456");
resp.setData(user);
resp.setCode("100000");
resp.setMessage("Получение успешно");
renderJson(resp);
}
}
@param — параметры запроса @title — заголовок интерфейса @respParam — возвращаемые параметры
Использование JFinal: из-за особенностей архитектуры JFinal невозможно получить доступ к корневому отображению извне. JDoc предлагает два способа решения этой проблемы:
/**
* Настройка маршрута доступа
*/
@Override
public void configRoute(Routes me) {
//TODO Настройка маршрута
new JFinalApiDocConfig().setClearSuffix("Controller").start();
}
new JFinalApiDocConfig().setUseClearSuffix(false).add("/jfinal", JFinalController.class).start();
Использование SpringMVC и SpringBoot:
package com.nmtx.springmvc.doc.config;
import com.nmtx.doc.core.api.springmvc.SpringMVCApiDocConfig;
public class SpringDocBuilder {
public static void main(String[] args) {
SpringMVCApiDocConfig doc = new SpringMVCApiDocConfig();
doc.setConfigFilePath("jdoc.properties");
doc.start();
}}
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Комментарии ( 0 )