使用showdoc生成接口文档

最新推荐文章于 2024-07-11 17:24:16 发布
最新推荐文章于 2024-07-11 17:24:16 发布
阅读量3k 收藏 4
点赞数 2
分类专栏： restful 文章标签： showdoc 在线生成接口文档
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Min_Monk/article/details/102875833
版权

今天在编写使用cxf开发restful接口的同时，发现了一个生成接口文档的一个工具，比较好用，这里记录下笔记。以 生成一个restful接口文档 为例。

  1. showdoc官网地址 https://www.showdoc.cc/
  2. 点击右上角的【登录/注册】，注册账号
  3. 登录进入showdoc
  4. 新建项目
  10. 复制生成的markdown格式的文档，回到本文中的第6步，将文档粘贴到左边文本域
  11. 然后点击右上角的保存按钮。
  12. 然后就可以通过https://www.showdoc.cc/zidingyi来访问刚刚生成的接口文档
Min_Monk
关注
  • 2
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
swagger-showdoc:一个将swagger的Json文件转换为ShowDoc的小工具
05-01
swagger-showdoc 项目介绍 很多在使用swagger的公司都有一个问题，文档真的可读性不高，在有些情况下，甚至只是开发人员自己能玩，完全不能作为开放文档使用。本项目旨在帮助使用swagger项目的团队，利用现有的swagger.json格式文件来实现文档的自动生成，文档的展示使用了showDoc 软件架构 Spring Boot 2.0.3 JDK 1.8 swagger2markup 1.3.3 okhttp 3.11.0 使用说明 克隆项目 直接运行SwaggerShowDocApplication 访问 输入各种参数，点击"开始文档同步"按钮 源码地址 GitHub： 码云： 参与贡献 Fork 本项目 新建分支 提交代码 新建 Pull Request License 用户在遵循本项目协议的同时，如果用户下载、安装、使用本项目中所提供的软件，软件作者对任何原因在使用本
showdoc自动生成接口文档
花遇和风的博客
08-05 1533
本文主要讲解showdoc + runapi （类似于postman）这两个工具组合使用，生成接口文档的操作。
showdoc sqli to rce漏洞利用思考
最新发布
C20220511的博客
07-11 532
password 和 $refer_url 参数都可控，可通过联合查询控制password的值满足条件返回$refer_url参数值，1') union select 1,2,3,4,5,6,7,8,9,0,11,12 --，6对应的是password字段，所以password参数传递6，条件成立，回显传入$refer_url参数，那么就存在sql注入。该处调用了is_dir，并且$file可控，熟悉phar反序列化的朋友都知道，is_dir函数可协议可控的情况下可触发反序列化。这个部分存放签名内容。
postman 文档、导出json脚本 导出响应数据 response ，showdoc导入postman json脚本 导出为文档word或markdown
test
06-24 8054
如果存在同名项目，会提示替换 或 拷贝导入：导入成功。直接 Export ：导出json脚本。
搭建showdoc文档工具
梦情与你的博客
05-21 747
一、准备 Nginx + PHP 环境 1、安装 Nginx 使用 yum 安装 Nginx： yum install nginx 2、修改 /etc/nginx/nginx.conf 文件为如下内容： user nginx; worker_processes auto; error_log /var/log/nginx/error.log; pid /run/nginx.pid; inclu...
使用Swagger自动生成API说明文档
12-14
一份关于使用Swagger自动生成API说明文档的开发文档。
showdoc接口文档平台客户端
01-06
Showdoc是一款优秀的接口文档管理工具，它为...通过使用Showdoc客户端，开发者和团队可以更加高效地管理接口文档，促进项目的顺利进行。无论是小型创业团队还是大型企业，Showdoc都是一个值得信赖的文档管理工具。
利用showdoc自动生成API文档
04-22
2. **Showdoc版本**：确保你使用的Showdoc版本是在2018年8月之后的，因为较旧的版本可能不支持自动生成API文档的功能。 ### 二、获取官方脚本 访问Showdoc的官方脚本地址...
It团队在线Api文档管理
07-10
通过这个工具，团队可以方便地管理API文档，使用PHP进行开发，并且能够自动或手动生成符合HTTP规范的接口文档。同时，它也支持创建和分享数据字典，有助于团队成员更好地理解和使用数据库结构。对于任何需要处理API...
showdoc Setup 1.0.3安装包
09-08
如果不想编辑markdown文档，你还可以利用showdoc的自动化能力，从程序注释中自动生成API文档，或者从搭配的RunApi客户端（类似postman的api调试工具）中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员...
showdoc-master.zip
07-28
5. **API 文档**：ShowDoc 特别适合于编写 API 文档，提供了自动生成接口文档的功能，方便开发者记录和分享 API 接口信息。 6. **模板与样式**：系统提供多种预设的模板和主题，可以根据项目需求选择合适的样式，使...
在线文档分享工具ShowDoc
weixin_34168880的博客
11-27 537
ShowDoc是什么 每当接手一个他人开发好的模块或者项目，看着那些没有写注释的代码，我们都无比抓狂。文档呢？！文档呢？！Show me the doc ！！ 程序员都很希望别人能写技术文档，而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版，想着新建的word文档放在哪个目录等各种非技术细节。 word文档零零散散地...
docker自动脚本搭建showdoc接口文档管理工具！
weixin_30832351的博客
10-22 156
一、安装docker 1，运行docker需要内核版本为3.8或者更高的版本,内核必须支持一种合适的存储驱动(Drivice Mapper、AUFS、vfs、btrfs、ZFS),默认存储驱动为Drivice Mapper或AUFS且内核必须开启cgroup和namespce功能. 　　uname -r可以查看内核版本. 　　内核升级 2，安装d...
保存内容到本地（下载到本地）
默默地博客
10-26 1677
js 保存内容到本地，下载到本地
学习路之api --接口文档和常见的状态码
Green
09-20 417
204： No Content，无内容。服务器成功处理，但未返回内容。在未更新网页的情况下，可确保浏览器继续显示当前文档。409：Conflict，服务器完成客户端的PUT请求时可能返回此代码，服务器处理请求时发生了冲突。201：Created 已创建。成功请求并创建了新的资源；302表示所有请求页面已经临时转至新的url；500：请求未完成，服务器遇到不可预知的情况。404：服务器无法找到被请求页面；403：服务器拒绝访问，权限不足；307和304表示使用缓存资源。200：OK，表示请求成功；
Show-Doc让你能在公司装一波的接口文档搭建全流程
代码界的扛把子
11-15 163
Run-API，前段时间，因为 Show-Doc 进行网站升级，忽然的一天早上 Run-API 失效了，这下整的阿粉就有崩溃了，啥情况，和阿粉对接的前端也有点懵逼，说接口文档忽然访问不了了，阿粉于是赶紧查看，原来是因为阿粉的接口，是完全的依托于 Show-Doc 的服务器进行了发布，为了防止这种情况的出现，阿粉就开始研究关于 Show-Doc 如何在自己的电脑行搭建一个服务，这样如果 Show-Doc 网站再次升级的时候，也就不会出现这么悲剧的事情了。还有一个就是 Linux 下有一键脚本安装，比较方便，
Showdoc使用——接口文档
qq_43842093的博客
02-28 2531
一、到showdoc官方注册账号 官方地址https://www.showdoc.com.cn/ 登录并创建一个项目,如图： 二、下载showdoc环境 再项目设置中有开发api,点开如下： 其中就是官方教程，简单全面。showdoc基础就是使用官方脚本 https://git-scm.com/download/win国内：这些都是showdoc官方推荐的，先安装git再下载showdoc脚本。 三、配置 上述的环境和脚本下好了后，将脚本放在需要生成接口文档的目录下，并编辑： api_key、api_t
showdoc安装与脚本生成文档
weixin_39218464的博客
02-09 2302
前言 showdoc官方提供了一种自动化生成接口和文档的方案。在代码里编写特定格式的程序注释，然后程序就可以通过读取这些注释来自动生成文档。由于这种方式不跟特定的语言耦合，因此它的使用范围相当广泛，可以支持c++、java、php、node等等常见的主流语言。 采用这种方式，尽管我们在第一次填写注释的时候可能会有些繁琐，但是它后期带来的可维护性是非常高的。代码变动后，不需要再额外登录showdoc，直接在代码里修改注释即可。同时自动化的脚本也可以加入持续集成或者某些自动化工程里，让“写接口和文档”这件事如”
showdoc设置API开放文档步骤
04-25
4. 填写API文档的相关信息，包括接口名称、接口描述、请求类型、请求参数、响应参数等。 5. 完成填写后，点击“保存”按钮，即可成功添加API文档。 6. 在API文档列表中找到刚才添加的API文档，点击“开放API”按钮。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值