如果您正在使用 Spring Boot 开发 RESTful API,您希望让其他开发人员尽可能容易地理解和使用您的 API。文档是必不可少的,因为它为将来的更新提供了参考,并帮助其他开发人员与您的 API 集成。很长一段时间以来,记录 REST API 的方法是使用 Swagger,这是一个开源软件框架,使开发人员能够设计、构建、记录和使用 RESTful Web 服务。2018 年,为..
原创
2024-07-17 14:38:22
143阅读
使用smart-doc 生成接口文档 方式一 插件方式 springboot 启动类 运行生成接口文档 1.pom文件 导入插件 <!--smart-doc 生成接口文档--> <plugin> <groupId>com.github.shalousun</groupId> <artifactId> ...
转载
2021-08-06 10:55:00
580阅读
接口文档生成工具
原创
2021-12-15 10:04:11
625阅读
build.gradle plugins { id "com.github.shalousun.smart-doc" version "2.2.2" } smartdoc { configFile = file("src/main/resources/smart-doc.json") } resou ...
转载
2021-08-31 11:05:00
876阅读
2评论
本文将详细介绍如何使用 `Smart-Doc` 生成 `Java WebSocket` 接口的文档,并提供一个完整的 `WebSocket` 服务端示例。
原创
2024-08-28 00:12:28
127阅读
本文详细介绍了如何在Java微服务项目中利用Smart-Doc工具自动生成gRPC API文档,包括配置步骤、优势分析以及实际操作指南,帮助开发者高效管理API文档。 ...
smart-doc是一个javarestfulapi文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc就能帮你生成一个简易明了的markdown或是一个像GitBook样式的静态html文档。下面将介绍如何在SpringB
原创
2019-10-11 16:10:08
10000+阅读
第一步: 添加plugin插件, 第二步: 新建smart-doc.json配置文件 第三步: 查看maven里面的plugins会出现smart-doc,会有生成接口文档的按钮。 ...
转载
2021-07-26 09:29:00
625阅读
2评论
既然有了Swagger, 为何还会产生Smart-Doc这类工具?本质上是Swagger侵入性和依赖性侵入性强:需要编写大
Smart-doc为JMeter性能压测注入了新的活力。本文探讨如何利用Smart-doc文档生成工具赋能JMeter性能测试。通过Smart-doc,用户可以快速的自动扫描代码生成JMeter性能测试脚本,提升性能压测的效率。
原创
2024-05-07 15:21:55
105阅读
1、准备舍弃swagger了,拥抱smart-doc。7)smart-doc扩展了注解,了解一下。9)查看smart-doc的token。3)配置smart-doc.json 。密码: 123456。
原创
2023-05-16 21:09:45
308阅读
本文将详细介绍如何在 Spring Boot 项目中整合 Smart-Doc,以及使用 Maven 插件一键生成多种格式的 API 文档。
今天小萌给大家推荐的一个开源Java Restful API 文档生成工具,一加【oneplus】、iflytek都在用。所以,自然差不了。官方简介smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需
转载
2021-06-03 08:42:07
457阅读
smart-doc[smɑːt dɒk]是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念, 完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。你只需要按照Javadoc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。
原创
2024-02-28 18:38:06
134阅读
今天小萌给大家推荐的一个开源Java Restful API 文档生成工具,一加【oneplus】、iflytek都在用。所以,自然差不了。官方简介smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需
原创
2021-03-21 17:55:15
973阅读
今天小萌给大家推荐的一个开源Java Restful API 文档生成工具,一加【oneplus】、iflytek都在用。所以,自然差不了。官方简介smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只
原创
2021-06-03 08:42:39
1037阅读
简介GitHub地址https://github.com/smart-doc-group/smart-doc/blob/master/README_CN.mdsmart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念
原创
2022-01-15 11:52:52
174阅读
通过Swagger系列可以快速生成API文档,但是这种API文档生成是需要在接口上添加注解等,这表明这是一种侵入式方式; 那么有没有非侵入式方式呢, 比如通过注释生成文档? 本文主要介绍非侵入式的方式及集成Smart-doc案例。我们构建知识体系时使用Smart-doc这类工具并不是目标,而是**要了解非侵入方式能做到什么程度和技术思路**。
原创
精选
2022-07-15 07:37:23
689阅读
简介GitHub地址https://github.com/smart-doc-group/smart-doc/blob/master/README_CN.mdsmart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念, 完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdo
原创
2021-08-18 09:56:51
296阅读
SMART原则 SMART原则(S=Specific、M=Measurable、A=Attainable、R=Relevant、T=Time-based) SMART原则简介 目标管理是使经理的工作变被动为主动的一个很好的手段,实施目标管理不但是有利于员工更加明确高效地工作,更是为未来的绩效考核制定了目标和考核标准,使考核更加科学化、规范化,更能保证考核的公开、公平与公正。毕竟,没有目标
转载
2024-05-23 16:34:12
57阅读