效果 目录 1. 查询指定项目属性接口 1. 查询指定项目属性 接口功能 获取制定项目的分类信息 URL http://www.api.com/index.php 支持格式 JSON HTTP请求方式 GET 请求参数 > 参数 必选 类型 name ture string 请求的项目名 type true int 请求项目的类型.1:类型一:2:类型二 . 返回字段 > 返回字段 字段类型 status int 返回结果状态.0:正常:1:错误. company string 所属公司名 c

接口说明: 登录接口 修订历史: 版本号 制定人 修订日期 0.0.2 zenghui 2017-09-27 0.0.1 zanshan 2017-02-20 URL: http://xxx.xx.com/api/login 请求方式: GET POST Header: 参数名 是否必须 类型 说明 Content-Type 是 string 请求类型: application/json Content-MD5 是 string 请求内容签名 请求参数: 参数名 是否必须 类型 说明 usern

前后端分离的工作模式于今是非常流行了,前后端工作的对接,就离开不了API文档的辅助. 根据自己以往的工作经历,以及了解的一些资讯,API文档的建立,无非以下几种方式: 1. word文档模板 2. 第三方平台,类如postman.showdoc等 3. 框架内单独自定义一套绑定路由的结构,再解析成html页面 4. 在框架内每个路由的方法的注释块里按照规则写注释,再解析生成api文档 5. 框架内直接编辑markdown文件,再转换成html页面 根据自己的使用心得,发表一下个人看法. 1.wo

在自定生成api文档方面以前都是使用swagger.json结合swagger工具来生成文档,偶然发现了apidoc这个生成api的工具,发现使用起来比swagger更加简单,下面整理一下使用过程: 1.安装 首先通过npm全局安装apidoc $ npm install apidoc -g 2.使用 使用的时候最主要是参考官方文档 ,apidoc文档,文档中清晰的记录了怎么使用的过程,最好也要看一下apidoc的github地址,从哪里你可以看到一个简单的example, 下面就是利用gith

一.应用场景 在公司中,有很多开发,每个人维护的api接口是不一样的.如果有一个统一的api文档管理平台,每个开发,把自己维护的接口录入进去. 之后再开发别的功能时,不需要重复造轮子,直接调用就可以了.有新员工入职时,也可以快速上手! 关于api文档管理,网上有很多.有在线收费的,也有开源的.基于节省成本考虑,这里主要介绍2个开源工具:ShowDoc和YApi. 下面会详细介绍着2个工具的使用方法,都是基于docker安装的! 二.ShowDoc ShowDoc是一个非常适合IT团队的在线API

一  简单介绍 不管是开源还是闭源,文档都是很重要的.当然理论上说,最好的文档就是代码本身,但是要让所有人都能读懂你的代码这太难了.所以我们要写文档.大部分情况,我们不希望维护一份代码再加上一份文档,这样做很容易造成文档和代码的不一致,程序员最讨厌更新文档了.所以最佳实践就是在程序员代码中加注释,然后通过构建脚本自通生成文档,包括html,latex,pdf等. 对应于Pyhon,有很多可供选择的工具: sphinx中文版介绍 Sphinx使用 reStructuredText作为标记语言(类似

系统庞大之后,前后端分离开发,前端调用后端提供的接口,请求协议一般是 HTTP,数据格式一般是 JSON.后台只负责数据的提供和计算,而完全不处理展现逻辑和样式:前端则负责拿到数据,组织数据并展现的工作.这样结构清晰,关注点分离,前后端会变得相对独立并松耦合.好处多多. 但是这样带来很多问题,前端可能需要拿到后端的数据之后,才能开始开发工作,等前端开发完成之后,然后再与后端一起联调.耗时不说,如果业务的需求更改,后端接口变更,怎么快速便捷告知前端的开发人员?还有其他如文档维护和及时更新的问题.这

大家好,我是小富~ 前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用docker自建文档服务,不过为了方便演示,我直接用了平台在线服务.官网地址: https://www.showdoc.com.cn/item/index 可以使用markdown语法来写API文档.数据字典文档.技术文档.在线excel文档.但像我这种资深的懒人程序员,其实更看重的是showdoc的自动化生

网址:http://apiary.io/ 介绍:一款非常强大的前后端交互api设计编辑工具(编辑器采用Markdown类似的描述标记,非常高效),高颜值的api文档,还能生成多种语言的测试代码. 中文教程参考: http://blog.csdn.net/pleasecallmewhy/article/details/29398559 案列: http://docs.gistfoxapi.apiary.io/#

由于Spring Boot能够快速开发.便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API.而我们构建RESTful API的目的通常都是由于多终端的原因,这些终端会共用很多底层业务逻辑,因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端. 这样一来,我们的RESTful API就有可能要面对多个开发人员或多个开发团队:IOS开发.Android开发或是Web开发等.为了减少与其他团队平时开发期间的频繁沟通成本,传统做法我们会创建一份RESTf

1.如果发现yuidoc命令用不了,那就重装nodejs吧 昨天不知道是清扫电脑的原因,yuidoc命令用不了(命令不存在),也没有找到好的解决方法,怒重装YUIDoc也不行.最后想了想,怒重装了nodejs,再装回YUIDoc,发现又可以了,原因还没找到. 2.YUIDoc的theme中的simple模板,sidebar.handlebar有写错. 里面属性遍历的properties被写成了events 3.YUIDoc example代码高亮错误的解决方法 使用过YUIDoc的人有可能会发现

Web API文档工具列表Swagger ——Swagger框架可以通过代码生成漂亮的在线API,甚至可以提供运行示例.支持Scala.Java.Javascript.Ruby.PHP甚至 Actionscript 3.在线 Demo .I/O Docs ——I/O Docs是一个用于RESTful Web APIs的交互式文档系统.使用 JSON 模型根据资源.方法和参数定义 APIs.I/O Docs 将生成 JavaScript 客户端接口,可通过这些接口来调用系统.服务器端基于 Node

PHPDocumentor是一个用PHP写的强大的文档自动生成工具,对于有规范注释的php程序,能够快速生成具有结构清晰.相互参照.索引等功能的API文档.旧版本是PHPDoc,PHPDoc是PEAR下面的一个非常优秀的模块,类似于Javadoc.从1.3.0开始,更名为phpDocumentor,新版本新加了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF.HTML.CHM等格式的文档,这样非常有利于代码的升级.维护.移交等. 前提:安装的前提是已经安装了

近来前端组小盆友开发的类库越来越多,很多情况下彼此不知道写了些什么方法,为了更好的合作提高工作效率,找了个比较好的api文档生成方法.使用jsdoc-toolkit来自动生成js api文档. 一. 环境搭建 1) 首先要安装java环境,如果不太了解的参看:http://jingyan.baidu.com/article/e75aca85b29c3b142edac6a8.html 2) 安装jsdoc-toolkit 下载地址:http://code.google.com/p/jsdoc-to

Grunt docs Grunt和 Grunt 插件是通过 npm 安装并管理的,npm是 Node.js 的包管理器. 安装 grunt-cli npm install grunt-cli -g 注意,安装grunt-cli并不等于安装了 Grunt!Grunt CLI的任务很简单:调用与Gruntfile在同一目录中 Grunt.这样带来的好处是,允许你在同一个系统上同时安装多个版本的 Grunt. 这样就能让多个版本的 Grunt 同时安装在同一台机器上. 每次运行grunt 时,他就利用

安装:Swashbuckle.AspNetCore 启用 XML 注释:右键单击“解决方案资源管理器”中的项目,然后选择“属性”.勾选“生成”选项卡的“输出”部分下的“XML 文档文件”框. 将 Swagger 生成器添加到 Startup.ConfigureServices 方法中的服务集合中: 注册Swagger生成器,定义一个和多个Swagger 文档 services.AddSwaggerGen(c => {      c.SwaggerDoc("v1", new Inf

SpringBoot非常适合开发 Restful API程序, 我们都知道为API文档非常重要, 但要维护好难度也很大, 原因有: 1. API文档如何能被方便地找到? 以文件的形式编写API文档都有这个问题, 使用在线 Wiki 等知识平台部分地能解决这个问题. 2. API文档经常过期. API 接口不断地被改进, 有些项目组使用Word软件编写API文档, 因版本管理难度大, 最后往往是API文档严重过时. 使用 Markdown 格式编写会好一些. Swagger 是一个非常好的工具,

随着前后端的分离,借口文档变的尤其重要,springfox是通过注解的形式自动生成API文档,利用它,可以很方便的书写restful API,swagger主要用于展示springfox生成的API文档. 官网地址:http://springfox.github.io/springfox/ Springfox大致原理 springfox的大致原理就是,在项目启动的过种中,spring上下文在初始化的过程,框架自动跟据配置加载一些swagger相关的bean到当前的上下文中,并自动扫描系统中可能需

影响我写文档的原因可能是代码和文档分离,有时候写完代码会忘记补文档,而且不能及时查看,使用 Flask-Docs 可以解决我的问题,这个插件可以根据代码注释生成文档页面,代码注释改动文档可以及时更新,而且支持离线文档下载. Flask-DocsFlask Api 文档自动生成插件 特性根据代码注释自动生成文档支持 Flask-RESTful支持离线 markdown 文档下载安装pip install Flask-Docs 使用from flask import Flaskfrom flask_

api文档 php 在项目中,需要协同开发,所以会写许多API文档给其他同事,以前都是写一个简单的TXT文本或Word文档,口口相传,这种方式比较老土了,所以,需要有个api管理系统专门来管理这些api,从网上找了许多比较好的开源文档管理系统,可以应用到项目中. 1.国外的话Swaggerswagger-ui 2.国内的Showdoc国内开源的非常好用的一款API文档管理系统,安装也非常方便,只需将源代码放到项目目录下自动安装运行即可,不要要注意PHP版本必须大于5.3. 3.界面简洁功能强大的

内容那么多,这个页面到底做了什么? 第一:解决微信文档APi文档使用不便: 第二:解决了内容搜索与索引:—— 最好是写成全文索引文档,但是比较需要时间,而且更新是一件麻烦的事:所以以下是直接 连接官网查看的: 第三:解决了完整性:—— 当你看文档时,无法掌握整体:这里可能更容易记忆目录整体: 第四:不一定每个人阅读后,都有作用!—— 可能本文档与你无缘: 目录2017-12-1911:37:56 网络 媒体 文件 数据缓存 位置 设备 界面 WXML节点信息 第三方平台 开放接口 数据 调试接口