接口文档生产工具（smart-doc）

最新推荐文章于 2024-08-10 08:43:00 发布
最新推荐文章于 2024-08-10 08:43:00 发布
阅读量733 收藏
点赞数
分类专栏： java 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_35909525/article/details/118156865
版权

1、smart-doc介绍

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念， 完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。

2、springboot项目

https://gitee.com/smart-doc-team/smart-doc/wikis/smart-doc%20maven%E6%8F%92%E4%BB%B6?sort_id=1791450

3、微服务类项目

 https://gitee.com/devin-alan/spring-boot-maven-multiple-module

 

砥砺前行A
关注
专栏目录
让文档和Demo生成更加简单和强大 - SmartDoc 0.1.1 说明
zhuobi0的专栏
01-08 668
新特性 smartDoc 0.1.1版正式发布，其中加入了更多方便生成文档的功能，主要特性如下： * 加入@demo配置项，看可以动态抓取html和js的内容作为@example，同时支持扩展@demo读取 * 支持jasmine测试js文件的单元代码抓取为@example * 实现多个example显示和tab切换 * 加入@show配置项来控制直接显示example效果 *
DocsBuilderGUI帮助文档生产工具
07-18
DocsBuilderGUI帮助文档生产工具
文档生产工具 Doxygen
weixin_33834628的博客
06-06 75
Doxygen是一种开源跨平台的，类似JavaDoc风格描述的文档系统，支持C、C++、Java、Objective-C等语言。可以从一套归档源文件开始，生成HTML，XML，pdf等不同风格的格式。 按照约定的格式注释源代码，用工具处理注释过的源代码产生文档，通过这种方式产生文档，有以下几个好处。 1. 便于代码和文档保持同步 2. 可以对文档做版本管理     使用方法 要使用Doxygen...
探索智能文档生成的新境界：Smart-Doc
最新发布
gitblog_00111的博客
08-10 322
探索智能文档生成的新境界：Smart-Doc smart-docSmart-doc is a java restful api document generation tool. Smart-doc is based on interface source code analysis to generate interface documentation, completely zero-inj...
文档生成工具有哪些？（总结）
yuyin86的专栏
10-09 1998
FAR HTML: HTML帮助文件实用工具, 提供对中文.CHM创建、编辑的良好支持。若创建的中文.CHM帮助文件出现乱码，可于编译.CHM文件前，修改FAR HTML创建的工程文件.HHP，在”项目设置“页更改其文件的语言与字体为相应的中文即可。 DocumentX！: 用于API文档的制作。自动提取lib库中的注释。 ASDoc: 创建HTML网页形式的API语
支持Dubbo接口文档生成的工具！
程序猿DD
12-24 591
点击上方蓝色“程序猿DD”，选择“设为星标”回复“资源”获取独家整理的学习资料！作者 |肥朝来源 |https://mp.weixin.qq.com/s/JW0yPtaIeyYZCs...
集成smart-doc插件零侵入自动生成RESTful格式API文档.zip
08-26
Smart-doc是一个Java工具，它可以零侵入地集成到Spring Boot应用中，自动从源代码中提取API信息并生成高质量的文档。"零侵入"意味着开发者无需在代码中添加额外的注解或配置，而是智能地分析已有的Spring MVC注解...
PyPI 官网下载 | smart-integration-cli-0.0.2b0.tar.gz
01-16
4. **命令行接口（CLI）**：`smart-integration-cli`可能提供了命令行工具，允许用户通过终端执行某些操作。这通常通过Python的`argparse`模块实现。 5. **版本管理**：按照`Semantic Versioning`（语义化版本）...
Smart3D系列教程6之案例实战演练3——倾斜数据正射影像及DSM的生产.doc
10-06
Smart3D 系列教程 6 之案例实战演练 3——倾斜数据正射影像及 DSM 的生产 本教程主要讲述了如何使用 Smart3D 建模软件生产倾斜数据正射影像和数字表面模型（DSM），并将其与 ArcGIS 软件结合，快速完成 GeoTIFF ...
SMART触摸屏程序下载方法.doc
09-29
在现代工业自动化领域中，触摸屏作为一种重要的人机交互工具，在实现生产过程监控、参数调整等方面发挥着至关重要的作用。SMART触摸屏作为一款高性能的人机界面（HMI）产品，其程序下载是设备调试与维护的关键步骤之...
2021-2022收藏的精品资料2021-2022年百日计划表下载.doc
09-16
文档标题和描述中提到的是一个2021-2022年的百日计划表，这通常是一个个人或团队用来规划和管理时间的工具，帮助达成目标和提高效率。百日计划表是一种短期规划，其核心是将长期目标分解为可操作的短期任务，以便在...
smart-doc的使用
星哲最开心
01-15 2965
smart-doc的使用
java 动态生产接口文档,smart-doc: smart-doc是一个java restful api文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实...
weixin_31088435的博客
03-20 458
Introducesmart-doc是一个java restful api文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照java标准注释的写，smart-doc就能帮你生成一个简易明了的markdown或是一个像GitBook样式的静态html文档。如果你已...
Spring集成Smart-Doc
qq_38382925的博客
05-31 603
写接口文档是一个重活，但是用这个完全基于注释，轻松不少。` 提示：根据官方使用手册，集成Smart-Doc。点击所需要的格式，enjoy it!
无入侵接口文档smart-doc
weixin_44315761的博客
08-29 428
1.非侵入式生成接口文档2.减少接口文档的手动更新麻烦&保证了接口文档和代码的一致3.随时可生成最新的接口文档4.保持团队代码风格一致:smart-doc支持javadoc，必须按照这个才能生成有注释的接口文档。
Smart-doc的脚本生成在线文档(精简官方文档描述)
wlpp520的博客
01-30 1166
Smart-doc的脚本生成在线文档(精简官方文档描述)
Django实战教程: 开发企业级应用智能文档管理系统smartdoc(1)
大江狗
08-29 6540
学好Django不仅可以开发中大型网站, 还可以开发专业的企业级 网络应用(Web App)。今天小编我就带你用Django开发一个企业级应用，一个名叫smartdoc的网络智能文档管理系统。在阅读本文前，请一定先阅读Django核心基础(3): View视图详解。一旦你使用通用视图，你就会爱上她。这是因为我们视图部分会直接使用Django的通用视图。如果你对代码有疑问，欢迎评论区留言。 ...
smart-doc Java Restful API 文档生成工具
个人学习笔记库，一篇一篇记录成长的足迹
03-02 2015
smart-doc Java Restful API 文档生成工具
Smart-doc中文文档
05-27
Smart-doc是一款基于Java注解的API文档生成工具，它可以通过注解方式生成API文档，并支持多种文档格式输出。以下是Smart-doc的中文文档： 1. [Smart-doc官方文档]...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值