首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

这些年用过API文档工具,个个是精品!

这些年用过不少API文档工具,也写过不少相关文章,发现哪种API文档工具更好用一直都是大家比较关心的话题。今天整理了下曾经用过7种API文档工具,每个都有详细使用教程,肯定有你中意一种!...Swagger Swagger是一款非常流行API文档工具,它能帮助你简化API文档开发,极大提高开发效率,之前在mall项目中就是使用它。...我们一般将Swagger和SpringBoot结合使用,使用是Springfox给我们提供工具。使用该工具可以根据注解自动生成API文档,并且可以在生成文档上进行接口调试。...由于API文档随着项目的启动而更新,所以API文档实时性很有保证!...如果你不介意在线使用API文档管理工具的话,可以使用Apifox,它功能更强大。 最后,大家用哪种API文档工具呢? 欢迎来投票统计看下!

1.4K30
您找到你想要的搜索结果了吗?
是的
没有找到

使用Swagger记录ASP.NET Web API

在本文中,将介绍一些可以为ASP.NET Web API生成文档方法。...除非您从未生成过Web API网站,否则您将会意识到,默认模板已经包含了为您可能实现API 生成文档功能,其中一个示例位于authme.ws。...入门 没有什么比一对夫妇文章更多已写入有关如何生成使用扬鞭用于ASP.NETWeb API文档(这里面的NuGet包称为Swashbuckle,你可以轻松地集成),但我需要东西少动-其实,需要生成表示我们提升到生产...传统文档(例如Sandcastle Help File Builder)显然不可行,因为它记录了托管代码,而不是更重要API接口和运行时模型。...不幸是,找不到Swagger Codegen ,所以我咬紧牙关,使用Maven和最新JDK 从源代码编译Java二进制文件。

1.9K60

ThinkPHP5使用Swagger-php接口文档

; 第2个路径是你想要生成这个目录下所有用swagger方式注释php文件,把所有注释生成api文档; 第3个路径是你存放生成swagger.json路径。...可能是这边默认安装是新版swagger(查看版本是3.0),提示找不到swagger 到bin这个目录,发现没有swagger文件,但是有一个openapi文件。...swagger.json) 如果json文件目录设置不对,则会提示Failed to load API definition. 6、快速更新文档 <?...Swagger方法时候,不能用这个\OpenApi\scan(path);提示找不到方法,需要用Swaggerscan(path);提示找不到方法,需要用\\Swagger\\scan(path);提示找不到方法...portal/test'; //你想要哪个文件夹下面的注释生成对应API文档 $swagger = \Swagger\scan($path); // header('Content-Type

78920

程序库设计

,有趣是,很多人都在谈论面向设计,各路 API 设计,还有程序语言设计,唯独搜索 “程序库设计”,无论中文还是英文,Google 还是百度都找不到太多内容。...但是想,没有程序员会否认库设计重要性吧,想在这里结合这个帖子谈谈想法。...很多库都有自己精心设计一套 DSL,比如链式调用等等几种方式,当然,这也和使用语言有关系。定义一种用起来舒服编程风格对于程序库推广是很有好处。这也是一致性一个体现。 内聚调用入口。...通常来说,程序库都配套有单元测试保证,无论是什么语言写。 健全文档组织。通常包括教程(tutorial)、开发者文档(developer guide)和接口 API 文档API doc)。...前者是帮助上手和建议使用,中间这个具备详尽特性介绍,后者则是传统 API 参考使用文档

15930

Laravel 开发 RESTful API 一些心得

最近用 Laravel 写了一段时间 API,总结一下自己心得吧。 Start API开发我们可以看到,有些网站用token验证身份,有些用OAuth2.0,当时也纠结,然后看到一个不错说法。...,没什么好说了 MethodNotAllowedHttpException这个是方法不对应,比如你是get路由,却post请求 文档 差点忘了这个,文档非常非常重要 是不怎么喜欢在注释写文档 使用...还把swagger-editorindex.html改成了edit.html,然后把这两个东西整合到同一个目录(记得修改css,js位置) 新建两个文件api.json,api.yaml 大概就和图中差不多...要修改图中箭头所示成为api.json位置 swagger 访问edit.html可以书写文档 编写语法 访问index.html可以查看文档 在edit.html写好之后,导出json...:laravel-api-helper 工作和API开发有关,用到其他有经验了再回来补补。

33610

使用Swagger记录ASP.NET Web API

在本文中,将介绍一些可以为ASP.NET Web API生成文档方法。在开发Web API过程中你会发现,默认模板已经包含了为可实现API 生成文档功能。...入门 有关如何使用Swagger生成ASP.NETWeb API文档文章已经有很多了(通过一个叫做SwashbuckleNuGet包,你可以轻松地对此进行集成),但我需要不那么“动态”东西——因为实际上需要...传统文档(例如Sandcastle Help File Builder)显然是不能满足我们要求,因为它记录是托管代码,而不是更重要API接口和运行时模型。...然而无奈是,找不到.NET可以用于Swagger Codegen端口,所以我强行做了个尝试:使用Maven和最新JDK从源代码编译Java二进制文件。...object”, “properties”:{} } 这可能是由于相关程序在响应时缺乏有关于数据类型足够信息。

2.2K70

Laravel 开发 RESTful API 一些心得

最近用 Laravel 写了一段时间 API,总结一下自己心得吧。 Start API开发我们可以看到,有些网站用token验证身份,有些用OAuth2.0,当时也纠结,然后看到一个不错说法。...验证 API 开发总会离不开验证,这里推荐使用jwt-auth,1.0 快要来了,新版本文档也很清晰 刚用 jwt-auth时有疑问,Laravel自带token验证使用是数据库apitoken字段验证...ModelNotFoundException这个是模型找不到异常,捕获之后,可以直接在控制器直接这样。...,没什么好说了 MethodNotAllowedHttpException这个是方法不对应,比如你是get路由,却post请求 文档 差点忘了这个,文档非常非常重要,是不怎么喜欢在注释写文档。...更多使用:laravel-api-helper(https://github.com/DavidNineRoc/laravel-api-helper) 工作和API开发有关,用到其他有经验了再回来补补

3.9K90

还在用丝袜哥(Swagger)做API文档?快来看看这款帮你减少百分之九十工作量开源工具。

于是乎,有一次在写代码(摸鱼)时候,偶然发现一个Gitee上高赞API文档,链接:smart-doc 主角smart-doc     smart-doc是一款同时支持JAVA REST API和...于是就照着官方文档案例,去部署生成了一下API文档,真香!...我们几乎没有写任何注释代码,就自动生成了一个API文档,没有任何侵入性。 smart-doc强在哪?     smart-doc对比传统一哥Swagger究竟有什么不同?...smart-doc主要是基于源代码和JAVADOC标注注释来生成文档,是在开发期或者是项目的编译期执行生成文档,意味着你是在项目编译完以后你在源码里面是找不到smart-doc任何依赖,0侵入性。...这也就是为什么刚刚什么注解都没写,但是依然可以生成合格API文档,于是乎马上把Swagger换成了smart-doc,只能说真香,再也不用写@ApiModel这种注解了。

39720

BUG赏金 | 无效API授权导致越权

图片来源于网络 大家好,想分享一下是如何在某邀请项目中发现一个简单API授权错误,该错误影响了数千个子域,并允许在无需用户干预情况下使用大量不受保护功能,从帐户删除到接管甚至于泄漏部分信息...,因为它列出了API文档并指定了请求和响应结构。...这让措手不及,因为这些端点似乎应该只供内部/高级用户使用。在没有任何APItoken或 authorization 头情况下直接调用端点会导致: ?...该网站似乎未提供任何API,并且找不到任何生成APItoken方法,因此决定稍后再进行检查。在对该网站进行深入分析后,仍然不能在请求或响应中找到一个APItoken。...Wow~biu踢佛,除了将帐户(权限)升级为高级用户之外,还可以成功调用几乎所有其他API端点。该文档详细说明了删除/接管/创建新帐户以及执行其他一些危险操作所需参数。

1.4K30

Astro网站部署到GitHub Pages踩坑记录

Astro 是集多功能于一体 Web 框架,用于构建快速、以内容为中心网站。 主要特性 组件支持:更快构建网站新 web 架构。 服务器优先 API 设计:去除高成本 Hydration。...有关 Astro 功能详细信息,请查阅为什么选择 Astro详细说明。... 参数,支持从官方示例或者任何 GitHub 存储库 main 分支创建 astro 项目。...项目结构和框架就不赘述了,可以查看官方文档。 部署到 GitHub Pages 在部署时候踩了一些坑,因为 Astro 是比较新框架嘛,网上也找不到相应资料,只能自己踩坑,不断地试错。...这里又踩坑了。重定向到 /index,部署到 GitHub Pages 打开空白,需要访问 w3way.top/index/index 才显示页面,但是这样的话样式又找不到样式,显示一堆文字。

79940

Src挖掘之手把手edusrc漏洞挖掘和github信息收集

然后再给师傅们分享下github官方文档: github检索文档 自动化工具——GitDorker GitDorker工具下载 GitDorker 是一款github自动信息收集工具,它利用 GitHub...搜索 API 和作者从各种来源编译大量 GitHub dorks 列表,以提供给定搜索查询 github 上存储敏感信息概述。...其中看js接口也是蛮重要一个点,比如常见api接口,就可以尝试使用js接口探测插件————FindSomething 可以探测到我们自己手工去找可能找不到接口。...上面就是尝试爆破然后成功获取到了上万条敏感信息。...传播、利用本文章所提供信息而造成任何直接或者间接后果及损失,均由使用者本人负责,作者不为此承担任何责任,一旦造成后果请自行承担!

17610

人脸识别登录认证:加强系统认证

二、需求介绍 在系统中,我们不用输入任何账号和密码,直接通过人脸识别,实现登陆。...,二是直接通过人脸去人脸库对比,具体使用哪一种请根据场景而定,这里采用是后者,是为了更加简单实现人脸识别认证,无需输入任何字符。...前端界面 后台处理 引入必要依赖,根据你申请 人脸识别不同版本有关,v2就使用v2版这里使用v3版依赖 ?...api依赖 是基于springboot框架进行开发,所以起初准备使用controller进行处理人脸登陆和注册请求,可是在调试过程中一直报错,d to instantiate [com.baidu.aip.face.AipFace...人脸登录: 查阅文档发现在登录和注册之都会使用到AipFace,通过这个配置初始化以下参数,参数分别是在编码之前我们准备三个参数 获取APP_ID 、API_KEY、API_KEY,

8.3K30

鸿蒙javascript项目开发----呼吸计时训练(基于华为轻量级运动手表)

有三个地址,第一个暂时全面点,第二个更偏向底层硬件开发板,第三个是JSAPI https://developer.harmonyos.com/cn/docs/documentation/doc-guides...,其实在官方文档里都有了,只是大家没注意到官方文档右上角,除了指南还有参考(API) 鸿蒙开发IDE(DevEco)如何下载?...为什么新建布局文件后直然后findComponentById一直报红色找不到问题? 目前这个2.0.8.203有些bug,官方已收到反馈,后续会修复。...目前在新建布局文件时候,ResourceTable一定找不到布局文件和id,此时需要重启编译器,每新建一个布局文件,就需要重启编译器才能找到你布局文件对应id。...左下角有个窗口图标,点一下里面就有previewer 为什么官方教程找到有些组件语法用不了? 不同设备,支持语法集大小不一样,猜测是跟内存和屏幕大小有关系。

63010

与时俱进 | 博客现已运行在 .NET Core 3.0 及 Azure 上

从 .NET Core 3.0 Preview 8 开始,一直在研究博客从 .NET Core 2.2 到 .NET Core 3.0迁移。大多数迁移路径可以遵循微软官方文档。...典型 ASP.NET Core 项目的迁移可能卡在这些第三方包上,因此请在迁移之前查看这些包是否有新版本发布。 不会在这里重复微软文档中已有的迁移步骤。...请按照正式文档所有内容首先将项目迁移到 .NET Core 3.0。但是到目前为止,以下内容并不在文档中,您可能需要注意。...="2.2.5" /> 你是肯定找不到他们3.0版本,因为大家太喜欢,所以砍了。...事实上,博客除了引用库依赖以外用户代码里,已经没有任何 Json.NET 痕迹了。

98520

使用Unsafe实现“无锁”原子数据结构 | 锁系列-Java中

现在市面上很少有关于Unsafe的话题。这个Unsafe有个compareAndSwap方法是原子,并且使用这个方法可以实现高性能lock-free数据结构。...首先我们实现一个没有同步计数器: ? 输出: ? 速度倒是挺快,但是线程之间完全没有排队,所以自然结果是不正确。 接下来我们通过添加synchronized关键字来实现简答计数器: ?...结果自然是正确。其实原子类型内部实现就是使用UnsafeCAS。 事实上,这个例子非常简单,但它却展示了Unsafe力量和神奇之处。...就像我们前面说到那样,CAS原子操作可以被用作实现“无锁”数据结构。....* API类,并且它不是J2SE中真正一部份,因此你可能找不到任何官方文档,更可悲是,它也没有比较好代码文档。 而且据说在Java9以后,这个类会被彻底隐藏掉,这个类也是蛮心酸

86690
领券