使用smart-doc 生成接口文档 方式一 插件方式 springboot 启动类 运行生成接口文档 1.pom文件 导入插件 <!--smart-doc 生成接口文档--> <plugin> <groupId>com.github.shalousun</groupId> <artifactId> ...
转载
2021-08-06 10:55:00
490阅读
接口文档生成工具
原创
2021-12-15 10:04:11
583阅读
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
831阅读
2评论
如果您正在使用 Spring Boot 开发 RESTful API,您希望让其他开发人员尽可能容易地理解和使用您的 API。文档是必不可少的,因为它为将来的更新提供了参考,并帮助其他开发人员与您的 API 集成。很长一段时间以来,记录 REST API 的方法是使用 Swagger,这是一个开源软件框架,使开发人员能够设计、构建、记录和使用 RESTful Web 服务。2018 年,为..
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
591阅读
2评论
Smart-doc为JMeter性能压测注入了新的活力。本文探讨如何利用Smart-doc文档生成工具赋能JMeter性能测试。通过Smart-doc,用户可以快速的自动扫描代码生成JMeter性能测试脚本,提升性能压测的效率。
本文将详细介绍如何使用 `Smart-Doc` 生成 `Java WebSocket` 接口的文档,并提供一个完整的 `WebSocket` 服务端示例。
1、准备舍弃swagger了,拥抱smart-doc。7)smart-doc扩展了注解,了解一下。9)查看smart-doc的token。3)配置smart-doc.json 。密码: 123456。
原创
2023-05-16 21:09:45
238阅读
今天小萌给大家推荐的一个开源Java Restful API 文档生成工具,一加【oneplus】、iflytek都在用。所以,自然差不了。官方简介smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需
转载
2021-06-03 08:42:07
422阅读
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+的文档。
今天小萌给大家推荐的一个开源Java Restful API 文档生成工具,一加【oneplus】、iflytek都在用。所以,自然差不了。官方简介smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需
原创
2021-03-21 17:55:15
899阅读
今天小萌给大家推荐的一个开源Java Restful API 文档生成工具,一加【oneplus】、iflytek都在用。所以,自然差不了。官方简介smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只
原创
2021-06-03 08:42:39
974阅读
ImportError: No module named 先写解决套路1. 环境安装包2. 自己写的包1. 自己写的包原因1: python2 没有加 `__init__.py`原因2. 没有加入包的root路径2. 环境的安装包3. VSCode 配置1. 配置运行参数参考文献 写一个笔记方便自己以后回查先写解决套路1. 环境安装包用which python检查当前解释器使用的是哪个pytho
pycharm在运行的时候,默认调用的是虚拟环境的python解释器,即venv (为了保证多个python版本不会冲突),这个和系统的python环境不一样如果在命令行中安装了第三方包,需要使用系统的python环境才能找到1、找到系统的python环境路径2、将系统的python环境作为解释器,不使用虚拟环境的python解释器如果使用默认的虚拟环境的python解释器,可以直接在pychar
原创
2023-01-06 15:57:52
138阅读
简介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
161阅读
通过Swagger系列可以快速生成API文档,但是这种API文档生成是需要在接口上添加注解等,这表明这是一种侵入式方式; 那么有没有非侵入式方式呢, 比如通过注释生成文档? 本文主要介绍非侵入式的方式及集成Smart-doc案例。我们构建知识体系时使用Smart-doc这类工具并不是目标,而是**要了解非侵入方式能做到什么程度和技术思路**。
原创
精选
2022-07-15 07:37:23
641阅读
简介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
254阅读
eclipse打jar包与找不到依赖包详解eclipse打工具jar1.项目右键-->export -->搜索java2.选择JAR file3.打包eclipse打包可执行jar1.项目右键-->export -->搜索java(参考上图)2.选择Runnable JAR file3.打包如下java命令行打包java -jar运行jar包找不到依
转载
2023-07-17 23:35:17
982阅读
首先我们来了解一下,为什么会出现这样的问题,以及python搜索包的机制是怎么样的1.为什么会出现这样的问题?包是向下搜索机制.2.为什么ide中执行没有报找不到包的问题?python搜索机制,在ide中是以项目为根路径, 所以它的搜索机制是从项目根路径开始向下搜索.3.为什么命令行执行时会报找不到包的错误?这是因为命令行执行的时候,是以当前执行的py文件所在目录级别的下一级开始搜索.这个可能有一