Smart-doc优点：

无侵入的接口文档、在线文档生成器。三种生成文档方式。对于程序代码开发中只需要加注释（符合一定的语法，五分钟可掌握）就能生成在线文档。可以支持c++、java、php、node等等常见的主流语言。

Smart-doc缺点：

注重文档内容，不提供测试、mock等功能，如果要使用测试mock等功能需要先用RunApi工具手动维护接口内容，而大部分比如postman、apifox等项目管理工具都是支持直接导入swagger文档自动生成的。而且swagger本身也提供了一定的接口测试功能，如果有测试的需要的话swagger可能是更好的选择。

如何使用：

ShowDoc，该连接指向官方文档阐述，字太多，觉得我阐述的不好的可以看官方的。以下我精简归纳一下

使用脚本实现：

前提环境：windows系统、git（下载git for windows：Git - Downloading Package）、shell脚本（https://www.showdoc.cc/script/showdoc_api.sh）

怎么写注释：（idea新建Live Template就能一劳永逸了）

//注释示例/*** showdoc* @catalog 测试文档/用户相关* @title 用户登录2* @description 用户登录的接口（参数以纯json的方式提交）* @method post* @url https://www.showdoc.com.cn/home/user/login2* @json_param {"username":"test","password":"***"} * @param username 必选 string 用户名  * @param password 必选 string 密码  * @return {"error_code":0,"data":{"uid":"1","username":"12154545","name":"吴系挂","groupid":2,"reg_time":"1436864169","last_login_time":"0"}}* @return_param groupid int 用户组id* @return_param name string 用户昵称* @remark 这里是备注信息* @number 99*/public function login2(){}

怎么生成在线文档：

showdoc_api.sh放在需要生成文档的代码目录下，脚本会遍历子目录的。（我是把要生成的文档的文件放到一个指定目录里面，这样很节省脚本执行时间）
编辑showdoc_api.sh，替换成自己的api_key 和 api_token，公共版的url不用动，保存
获取api_key 和 api_token（生成对应的项目目录，每个项目都又子集的key和token）
1. 如果你的项目是在showdoc网页上创建的，则请登录showdoc，进入某个项目的设置，点击开放API，便可以看到api_key 和 api_token的说明
2. 如果你的项目是在runapi客户端（ ShowDoc ）上创建的，则可以点击runapi客户端最左侧的菜单栏，选择“项目”。然后点击其中一个项目的“自动生成”按钮，便可以看到api_key 和 api_token的说明
双击运行showdoc_api.sh脚本，生成在线文档了，去自己的smart-doc账户上看看吧。

Smart-doc的脚本生成在线文档(精简官方文档描述)相关推荐

jca oracle官方文档,Oracle 官方文档说明
Oracle 官方文档说明相关的部分并没有全部罗列,只列举了常用的文档. 没有罗列开发相关的部分(SQL / PL/SQL例外). 部分内容是在OCP课程之外的. oracle 错误号参考 Erro ...
oracle语法官方文档,Oracle官方文档必备语法知识
很多Oracle DBA虽然接触Oracle时间很长,但是一旦想不起语法或找不出相应参数时,习惯百度或谷歌.虽然已经下载了官方文档,但是 Oracle官方文档必备语法知识 [日期:2015-04-21 ...
python3 scrapy中文文档_Scrapy官方文档笔记
1.创建Scrapy项目首先用cmd命令行去操作,输入 scrapy startproject 项目名 #这里输入的项目名,就是在你输入的目录它会建立一个新的文件夹,这个文件夹里面还是同样名字的一个 ...
最新Elasticsearch8.4.3 + Kibana8.4.3在云服务器Centos7.9安装部署（参考官方文档）
一.前言最近笔者学习Elasticsearch,官方最新稳定版为 Elasticsearch-8.4.3,想在云服务器上Centos7.9搭建.搭建之路坑多路少啊(指网上的博文教程五花八门,基本 ...
如何快速掌握oracle,教你如何快速从 Oracle 官方文档中获取需要的知识
以下链接可查看 11g 到 20c 的在线官方文档. https://docs.oracle.com/en/database/oracle/oracle-database/index.html 如图, ...
【SpringBoot】SpringBoot、ThemeLeaf 官方文档地址
SpringBoot官方文档 - Spring Boot Reference Documentation 页面如下: 在 Documentation Overview 中,附有 PDF 版本下载地址, ...
mysql中括号_手把手教你看MySQL官方文档
前言: 在学习和使用MySQL的过程中,难免会遇到各种问题.不知道当你遇到相关问题时会怎么做,我在工作或写文章的过程中,遇到不懂或需要求证的问题时通常会去查阅官方文档.慢慢的,阅读文档也有了一些经验, ...
如何全文搜索oracle官方文档
如何全文搜索oracle官方文档 [技巧]如何全文搜索oracle官方文档一.1 BLOG文档结构图一.2 导读和注意事项各位技术爱好者,看完本文后,你可以掌握如下的技能,也可以学到一些其它 ...
【技巧】如何全文搜索oracle官方文档
一.1 BLOG文档结构图一.2 导读和注意事项各位技术爱好者,看完本文后,你可以掌握如下的技能,也可以学到一些其它你所不知道的知识,~O(∩_∩)O~: ① 如何在线和离线查看oracle官 ...

Smart-doc的脚本生成在线文档(精简官方文档描述)

Smart-doc优点：

Smart-doc缺点：

如何使用：

使用脚本实现：

Smart-doc的脚本生成在线文档(精简官方文档描述)相关推荐

最新文章

热门文章