摘要:目前支持的变成语言有,,,等,主流的编成语言都支持。文件时你要生成文档的目录,也是最后要使用的目录。是一项免费的服务,它允许你把你的静态页面发布出去共其他用户通过浏览器查看。
你的项目在用什么工具书写api文档?今天就来给大家推荐下ApiDoc1. ApiDoc是什么? ApiDoc可以根据你再代码里的注释,来生成api描述文档,这样就不用你自己去告诉端的小伙伴该怎么调用你的api了。目前支持的变成语言有:Java,Javascript,Php,Python,C#,Ruby,Lua等,主流的编成语言都支持。 2. 怎么用? 很简单,只要在你的代码里用这样的注解申明你的接口信息就好
/** * @api {get} /user/:id Request User information * @apiName GetUser * @apiGroup User * * @apiParam {Number} id Users unique ID. * * @apiSuccess {String} firstname Firstname of the User. * @apiSuccess {String} lastname Lastname of the User. */这里面的这些注解都是ApiDoc定义好的,你只要按照官方文档使用就好了。ApiDoc 官网 3. 开始搞起来
安装
npm install apidoc -g
运行
apidoc -i api/ -o docs/
api是你的代码目录也就是你使用注释的文件目录,它会自动扫描使用注解的文件。docs文件时你要生成api文档的目录,也是github page最后要使用的目录。
检查api文档
在docs目录下直接打开index.html就可以查看最终结果了。
创建github仓库
将自己的生成后的戴阿曼上船,就是docs整个目录
在仓库的 setting中开启page服务
用page提供的url去访问
总结ApiDoc提供了更好的api文档阅读体验,对于开发者来说免去了写文档的麻烦。不过不足就是不能像swagger那样提供在线调试,而且要想描述一个api需要些很多的注释。
文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。
转载请注明本文地址:https://www.ucloud.cn/yun/99403.html
摘要:目前支持的变成语言有,,,等,主流的编成语言都支持。文件时你要生成文档的目录,也是最后要使用的目录。是一项免费的服务,它允许你把你的静态页面发布出去共其他用户通过浏览器查看。 你的项目在用什么工具书写api文档?今天就来给大家推荐下ApiDoc 1. ApiDoc是什么? ApiDoc可以根据你再代码里的注释,来生成api描述文档,这样就不用你自己去告诉端的小伙伴该怎么调用你的api了...
摘要:目前支持的变成语言有,,,等,主流的编成语言都支持。文件时你要生成文档的目录,也是最后要使用的目录。是一项免费的服务,它允许你把你的静态页面发布出去共其他用户通过浏览器查看。 你的项目在用什么工具书写api文档?今天就来给大家推荐下ApiDoc 1. ApiDoc是什么? ApiDoc可以根据你再代码里的注释,来生成api描述文档,这样就不用你自己去告诉端的小伙伴该怎么调用你的api了...
摘要:国外的话国内的国内开源的非常好用的一款文档管理系统,安装也非常方便,只需将源代码放到项目目录下自动安装运行即可,不要要注意版本必须大于界面简洁功能强大的阿里的接口管理工具,开源免费,接口自动化,数据自动生成,自动化测试,企业级管理。 在项目中,需要协同开发,所以会写许多API文档给其他同事,以前都是写一个简单的TXT文本或Word文档,口口相传,这种方式比较老土了,所以,需要有个api...
摘要:影响我写文档的原因可能是代码和文档分离,有时候写完代码会忘记补文档,而且不能及时查看,使用可以解决我的问题,这个插件可以根据代码注释生成文档页面,代码注释改动文档可以及时更新,而且支持离线文档下载。 影响我写文档的原因可能是代码和文档分离,有时候写完代码会忘记补文档,而且不能及时查看,使用 Flask-Docs 可以解决我的问题,这个插件可以根据代码注释生成文档页面,代码注释改动文档可...
阅读 2301·2021-10-11 10:59
阅读 2666·2021-09-22 15:49
阅读 2608·2021-08-13 13:25
阅读 1252·2019-08-30 13:14
阅读 2354·2019-08-29 18:45
阅读 2946·2019-08-29 18:36
阅读 1455·2019-08-29 13:21
阅读 1131·2019-08-26 11:44