请选择 进入手机版 | 继续访问电脑版
  • 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

spring-adorner: spring mvc api接口文档生成利器

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

spring-adorner

开源软件地址:

https://gitee.com/jaemon/spring-adorner

开源软件介绍:

Spring Adorner Logo

Jaemon/Spring-Adorner

Gitee license JDK springboot 2.4.5 Read the Docs

spring mvc api接口文档生成利器

为什么选择Spring Adorner? 开源社区已有swagger-apiJApiDocs等一系列非常优秀的api文档生成器开源项目,但是却也有其不足之处。

  • swagger-api: 代码侵入性强
  • JApiDocs: 生成的markdown格式的api文档格式不美观,无法定制化

 

Spring Adorner项目设立初衷是打造为一款纯API接口文档生成的轻量级工具

 

如果觉得项目对您的工作有帮助的话, 欢迎WatchStarFork三连击

 

☑ Quickly Start

引入Adorner依赖包

<dependency>    <groupId>io.gitee.jaemon</groupId>    <artifactId>spring-adorner</artifactId>    <version>${adorner.version}</version></dependency>

adorner.version版本号取值

 

使用Adorner生成API接口文档

不解析注释

public class AdornerApplication {    public static void main(String[] args) {        // 指定API文档生成路径(包括文件名)        String filePath = "/home/jaemon/api/api.md";        // 待扫描的API接口包路径(注意修改为实际项目中的包路径)        String packageName = "io.gitee.jaemon.spring.adorner.contorller";            SpringAdornerStarter.generate(filePath, packageName);    }}

解析注释

public class AdornerApplication {    public static void main(String[] args) {        // 指定API文档生成路径(包括文件名)        String filePath = "/home/jaemon/api/api.md";        // 待扫描的API接口包路径(注意修改为实际项目中的包路径)        String packageName = "io.gitee.jaemon.spring.adorner.contorller";        // 注释扫描器        DocScanner docScanner = DocScanner.of(                // 需要解析注释的包路径                Lists.newArrayList("io.gitee.jaemon.spring.adorner.contorller", "io.gitee.jaemon.spring.adorner.entity")        );        // 定义Adorner上下文配置对象        AdornerApplicationContext context = AdornerApplicationContext.builder()                .docScanner(docScanner)                .build(filePath, new String[]{packageName});        SpringAdornerStarter.generate(context);    }}

 

✉ Documentation, Getting Started and Developer Guides

 

✎ Upgrade Log

 

✍ Feedback

 


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

上一篇:
JkdYaf: 基于 YAF + SWOOLE 高性能API框架发布时间:2022-02-18
下一篇:
go-apiserver: 一个简单的go apiserver小框架发布时间:2022-02-18
热门推荐
阅读排行榜
  • ** REJECT ** DO NOT USE THIS CANDIDATE NUMBER. ConsultIDs: none. Reason: This ca

    阅读:234|2022-09-23
  • Simple Task Scheduling System v1.0 was discovered to contain a SQL injection vul

    阅读:206|2022-09-18
  • Simple Task Scheduling System v1.0 was discovered to contain a SQL injection vul

    阅读:215|2022-09-18
  • Novel-Plus v3.6.2 was discovered to contain a hard-coded JWT key located in the

    阅读:223|2022-09-18
  • Novel-Plus v3.6.2 was discovered to contain an arbitrary file download vulnerabi

    阅读:222|2022-09-18
  • Simple Task Scheduling System v1.0 was discovered to contain a SQL injection vul

    阅读:124|2022-09-18
  • An issue was discovered in the Arm Mali GPU Kernel Driver. A non-privileged user

    阅读:244|2022-09-18
  • HashiCorp Boundary up to 0.10.1 did not properly perform data integrity checks t

    阅读:184|2022-09-18
  • In D-Link DIR-816 A2_v1.10CNB04.img a command injection vulnerability occurs in

    阅读:215|2022-09-18
  • D-Link DIR-816 A2_v1.10CNB04.img is vulnerable to Command Injection via /goform/

    阅读:190|2022-09-18

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap