feat: add archive freemarker custom tag.

Author: ruibaby

src/main/java/run/halo/app/controller/admin/api/AdminController.java

@@ -24,7 +24,7 @@
  *
  * @author johnniang
  * @author ryanwang
- * @date 3/19/19
+ * @date 2019-03-19
  */
 @Slf4j
 @RestController
@@ -41,7 +41,7 @@ public AdminController(AdminService adminService, OptionService optionService) {
     }
 
     @GetMapping(value = "/is_installed")
-    @ApiOperation("Check install status")
+    @ApiOperation("Checks Installation status")
     public boolean isInstall() {
         return optionService.getByPropertyOrDefault(PrimaryProperties.IS_INSTALLED, Boolean.class, false);
     }
@@ -61,13 +61,13 @@ public void logout() {
     }
 
     @PostMapping("password/code")
-    @ApiOperation("Send reset password verify code.")
+    @ApiOperation("Sends reset password verify code")
     public void sendResetCode(@RequestBody @Valid ResetPasswordParam param) {
         adminService.sendResetPasswordCode(param);
     }
 
     @PutMapping("password/reset")
-    @ApiOperation("Reset password by verify code.")
+    @ApiOperation("Resets password by verify code")
     public void resetPassword(@RequestBody @Valid ResetPasswordParam param) {
         adminService.resetPasswordByCode(param);
     }
@@ -79,11 +79,6 @@ public AuthToken refresh(@PathVariable("refreshToken") String refreshToken) {
         return adminService.refreshToken(refreshToken);
     }
 
-    /**
-     * Get some statistics about the count of posts, the count of comments, etc.
-     *
-     * @return counts
-     */
     @GetMapping("counts")
     @ApiOperation("Gets count info")
     @Deprecated
@@ -104,31 +99,31 @@ public void updateAdmin() {
     }
 
     @GetMapping("spring/application.yaml")
-    @ApiOperation("Get application config content")
+    @ApiOperation("Gets application config content")
     public BaseResponse<String> getSpringApplicationConfig() {
         return BaseResponse.ok(HttpStatus.OK.getReasonPhrase(), adminService.getApplicationConfig());
     }
 
-    @PutMapping("spring/application.yaml/update")
-    @ApiOperation("Update application config content")
+    @PutMapping("spring/application.yaml")
+    @ApiOperation("Updates application config content")
     public void updateSpringApplicationConfig(@RequestParam(name = "content") String content) {
         adminService.updateApplicationConfig(content);
     }
 
     @PostMapping(value = {"halo/restart", "spring/restart"})
-    @ApiOperation("Restart halo server")
+    @ApiOperation("Restarts halo server")
     public void restartApplication() {
         Application.restart();
     }
 
     @GetMapping(value = "halo/logfile")
-    @ApiOperation("Get halo log file content.")
+    @ApiOperation("Gets halo log file content")
     public BaseResponse<String> getLogFiles(@RequestParam("lines") Long lines) {
         return BaseResponse.ok(HttpStatus.OK.getReasonPhrase(), adminService.getLogFiles(lines));
     }
 
     @GetMapping(value = "halo/logfile/download")
-    @ApiOperation("Download halo log file.")
+    @ApiOperation("Downloads halo log file")
     public void downloadLogFiles(@RequestParam("lines") Long lines, HttpServletResponse response) {
         adminService.downloadLogFiles(lines, response);
     }

src/main/java/run/halo/app/controller/admin/api/AttachmentController.java

@@ -36,26 +36,14 @@ public AttachmentController(AttachmentService attachmentService) {
         this.attachmentService = attachmentService;
     }
 
-    /**
-     * List of attachment.
-     *
-     * @param pageable pageable
-     * @return Page<AttachmentDTO>
-     */
     @GetMapping
     public Page<AttachmentDTO> pageBy(@PageableDefault(sort = "updateTime", direction = DESC) Pageable pageable,
                                       AttachmentQuery attachmentQuery) {
         return attachmentService.pageDtosBy(pageable, attachmentQuery);
     }
 
-    /**
-     * Get attachment by id.
-     *
-     * @param id attachment id
-     * @return AttachmentDTO
-     */
     @GetMapping("{id:\\d+}")
-    @ApiOperation("Get attachment detail by id")
+    @ApiOperation("Gets attachment detail by id")
     public AttachmentDTO getBy(@PathVariable("id") Integer id) {
         Attachment attachment = attachmentService.getById(id);
         return attachmentService.convertToDto(attachment);
@@ -70,19 +58,14 @@ public AttachmentDTO updateBy(@PathVariable("attachmentId") Integer attachmentId
         return new AttachmentDTO().convertFrom(attachmentService.update(attachment));
     }
 
-    /**
-     * Delete attachment by id
-     *
-     * @param id id
-     */
     @DeleteMapping("{id:\\d+}")
-    @ApiOperation("Delete attachment permanently by id")
+    @ApiOperation("Deletes attachment permanently by id")
     public AttachmentDTO deletePermanently(@PathVariable("id") Integer id) {
         return attachmentService.convertToDto(attachmentService.removePermanently(id));
     }
 
     @DeleteMapping
-    @ApiOperation("Delete attachments permanently in batch by id array")
+    @ApiOperation("Deletes attachments permanently in batch by id array")
     public List<Attachment> deletePermanentlyInBatch(@RequestBody List<Integer> ids) {
         return attachmentService.removePermanently(ids);
     }

src/main/java/run/halo/app/controller/admin/api/BackupController.java

@@ -43,19 +43,19 @@ public BackupController(BackupService backupService) {
     }
 
     @PostMapping("halo")
-    @ApiOperation("Backup halo")
+    @ApiOperation("Backups halo")
     public BackupDTO backupHalo() {
         return backupService.zipWorkDirectory();
     }
 
     @GetMapping("halo")
-    @ApiOperation("Get all backups")
+    @ApiOperation("Gets all backups")
     public List<BackupDTO> listBackups() {
         return backupService.listHaloBackups();
     }
 
     @GetMapping("halo/{fileName:.+}")
-    @ApiOperation("Download backup file")
+    @ApiOperation("Downloads backup file")
     public ResponseEntity<Resource> downloadBackup(@PathVariable("fileName") String fileName, HttpServletRequest request) {
         log.info("Try to download backup file: [{}]", fileName);
 
@@ -77,7 +77,7 @@ public ResponseEntity<Resource> downloadBackup(@PathVariable("fileName") String
     }
 
     @DeleteMapping("halo")
-    @ApiOperation("Delete a backup")
+    @ApiOperation("Deletes a backup")
     public void deleteBackup(@RequestParam("filename") String filename) {
         backupService.deleteHaloBackup(filename);
     }

src/main/java/run/halo/app/controller/admin/api/CategoryController.java

@@ -21,7 +21,7 @@
  * Category controller.
  *
  * @author johnniang
- * @date 3/21/19
+ * @date 2019-03-21
  */
 @RestController
 @RequestMapping("/api/admin/categories")

src/main/java/run/halo/app/controller/admin/api/InstallController.java

@@ -2,6 +2,7 @@
 
 import cn.hutool.core.text.StrBuilder;
 import cn.hutool.crypto.SecureUtil;
+import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.context.ApplicationEventPublisher;
@@ -78,6 +79,7 @@ public InstallController(UserService userService,
     @PostMapping
     @ResponseBody
     @CacheLock
+    @ApiOperation("Initializes the blog")
     public BaseResponse<String> installBlog(@RequestBody InstallParam installParam) {
         // Validate manually
         ValidationUtils.validate(installParam, CreateCheck.class);

src/main/java/run/halo/app/controller/admin/api/JournalCommentController.java

@@ -27,7 +27,7 @@
  * Journal comment controller.
  *
  * @author johnniang
- * @date 19-4-25
+ * @date 2019-04-25
  */
 @RestController
 @RequestMapping("/api/admin/journals/comments")
@@ -53,6 +53,7 @@ public Page<JournalCommentWithJournalVO> pageBy(@PageableDefault(sort = "updateT
     }
 
     @GetMapping("latest")
+    @ApiOperation("Lists latest journal comments")
     public List<JournalCommentWithJournalVO> listLatest(@RequestParam(name = "top", defaultValue = "10") int top,
                                                         @RequestParam(name = "status", required = false) CommentStatus status) {
         List<JournalComment> latestComments = journalCommentService.pageLatest(top, status).getContent();

src/main/java/run/halo/app/controller/admin/api/LinkController.java

@@ -12,11 +12,14 @@
 import javax.validation.Valid;
 import java.util.List;
 
+import static org.springframework.data.domain.Sort.Direction.ASC;
+import static org.springframework.data.domain.Sort.Direction.DESC;
+
 /**
  * Link Controller
  *
  * @author ryanwang
- * @date 2019/3/21
+ * @date 2019-03-21
  */
 @RestController
 @RequestMapping("/api/admin/links")
@@ -28,36 +31,26 @@ public LinkController(LinkService linkService) {
         this.linkService = linkService;
     }
 
-    /**
-     * List all links
-     *
-     * @param sort sort
-     * @return List
-     */
     @GetMapping
-    public List<LinkDTO> listLinks(@SortDefault(sort = "priority", direction = Sort.Direction.ASC) Sort sort) {
-        return linkService.listDtos(sort);
+    @ApiOperation("Lists links")
+    public List<LinkDTO> listLinks(@SortDefault(sort = "team", direction = DESC) Sort sort) {
+        return linkService.listDtos(sort.and(Sort.by(ASC, "priority")));
     }
 
-    /**
-     * Get link by id.
-     *
-     * @param id id
-     * @return LinkDTO
-     */
     @GetMapping("{id:\\d+}")
-    @ApiOperation("Get link detail by id")
+    @ApiOperation("Gets link detail by id")
     public LinkDTO getBy(@PathVariable("id") Integer id) {
         return new LinkDTO().convertFrom(linkService.getById(id));
     }
 
     @GetMapping("parse")
-    @ApiOperation("Get link by parse url")
+    @ApiOperation("Gets link by parse url")
     public LinkDTO getByParse(@RequestParam("url") String url) {
         return linkService.getByParse(url);
     }
 
     @PostMapping
+    @ApiOperation("Creates a link")
     public LinkDTO createBy(@RequestBody @Valid LinkParam linkParam) {
         Link link = linkService.createBy(linkParam);
         return new LinkDTO().convertFrom(link);
@@ -72,19 +65,14 @@ public LinkDTO updateBy(@PathVariable("id") Integer id,
         return new LinkDTO().convertFrom(linkService.update(link));
     }
 
-    /**
-     * Delete link by id.
-     *
-     * @param id id
-     */
     @DeleteMapping("{id:\\d+}")
     @ApiOperation("Delete link by id")
     public void deletePermanently(@PathVariable("id") Integer id) {
         linkService.removeById(id);
     }
 
     @GetMapping("teams")
-    @ApiOperation(("List all link teams"))
+    @ApiOperation(("Lists all link teams"))
     public List<String> teams() {
         return linkService.listAllTeams();
     }

src/main/java/run/halo/app/controller/admin/api/LogController.java

@@ -20,7 +20,7 @@
  * Log controller.
  *
  * @author johnniang
- * @date 3/19/19
+ * @date 2019-03-19
  */
 @RestController
 @RequestMapping("/api/admin/logs")
@@ -32,29 +32,21 @@ public LogController(LogService logService) {
         this.logService = logService;
     }
 
-    /**
-     * List latest logs.
-     *
-     * @param top top
-     * @return List of logs
-     */
     @GetMapping("latest")
     @ApiOperation("Pages latest logs")
     public List<LogDTO> pageLatest(@RequestParam(name = "top", defaultValue = "10") int top) {
         return logService.pageLatest(top).getContent();
     }
 
     @GetMapping
+    @ApiOperation("Lists logs")
     public Page<LogDTO> pageBy(@PageableDefault(sort = "updateTime", direction = DESC) Pageable pageable) {
         Page<Log> logPage = logService.listAll(pageable);
         return logPage.map(log -> new LogDTO().convertFrom(log));
     }
 
-    /**
-     * Clear all logs.
-     */
     @GetMapping("clear")
-    @ApiOperation("Clear all logs")
+    @ApiOperation("Clears all logs")
     public void clear() {
         logService.removeAll();
     }

src/main/java/run/halo/app/controller/admin/api/MailController.java

@@ -1,5 +1,6 @@
 package run.halo.app.controller.admin.api;
 
+import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -14,7 +15,7 @@
  * Mail controller.
  *
  * @author johnniang
- * @date 19-5-7
+ * @date 2019-05-07
  */
 @RestController
 @RequestMapping("/api/admin/mails")
@@ -27,6 +28,7 @@ public MailController(MailService mailService) {
     }
 
     @PostMapping("test")
+    @ApiOperation("Tests the SMTP service")
     public BaseResponse testMail(@Valid @RequestBody MailParam mailParam) {
         mailService.sendMail(mailParam.getTo(), mailParam.getSubject(), mailParam.getContent());
         return BaseResponse.ok("发送成功");

src/main/java/run/halo/app/controller/admin/api/MenuController.java

@@ -35,24 +35,18 @@ public MenuController(MenuService menuService) {
 
     @GetMapping
     @ApiOperation("Lists all menus")
-    public List<MenuDTO> listAll(@SortDefault(sort = "priority", direction = DESC) Sort sort) {
-        return menuService.listDtos(sort);
+    public List<MenuDTO> listAll(@SortDefault(sort = "team", direction = DESC) Sort sort) {
+        return menuService.listDtos(sort.and(Sort.by(ASC, "priority")));
     }
 
     @GetMapping("tree_view")
-    @ApiOperation("List as category tree")
-    public List<MenuVO> listAsTree(@SortDefault(sort = "priority", direction = ASC) Sort sort) {
-        return menuService.listAsTree(sort);
+    @ApiOperation("Lists categories as tree")
+    public List<MenuVO> listAsTree(@SortDefault(sort = "team", direction = DESC) Sort sort) {
+        return menuService.listAsTree(sort.and(Sort.by(ASC, "priority")));
     }
 
-    /**
-     * Get menu by menuId.
-     *
-     * @param menuId menuId
-     * @return MenuDTO
-     */
     @GetMapping("{menuId:\\d+}")
-    @ApiOperation("Get menu detail by id")
+    @ApiOperation("Gets menu detail by id")
     public MenuDTO getBy(@PathVariable("menuId") Integer menuId) {
         return new MenuDTO().convertFrom(menuService.getById(menuId));
     }
@@ -91,7 +85,7 @@ public MenuDTO deleteBy(@PathVariable("menuId") Integer menuId) {
     }
 
     @GetMapping("teams")
-    @ApiOperation(("List all menu teams"))
+    @ApiOperation(("Lists all menu teams"))
     public List<String> teams() {
         return menuService.listAllTeams();
     }