精华内容
下载资源
问答
  • API接口文档格式书写

    2020-12-29 09:21:09
    word版本接口文档书写格式
  • markdown编写api接口文档的示例,
  • java的API接口文档模板

    2021-01-12 10:16:44
    java初学者
  • 最近在测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现。 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化测试 环境 Python3.6 ,PyCharm,W7...
  • api接口技术文档

    2018-08-16 14:50:44
    api接口技术文档api接口交付文档api接口使用说明文档,例子为简单人员和部门
  • restful前后端分离api接口文档模板,javaweb开发接口文档
  • api接口文档模板

    千次下载 热门讨论 2014-03-06 16:00:51
    api接口文档模板
  • markdown在线api接口编辑,像代码一样的编写接口文档.zip,showdoc是一个非常适合it团队在线共享文档的工具
  • API 接口 设计文档 模板

    千次下载 热门讨论 2014-05-28 11:52:14
    API 接口 设计文档 模板,保存日后使用。
  • API文档范例

    2018-02-23 14:19:33
    API文档规范,用于新手快速了解API文档如何编写,便于前后台开发人员沟通,了解数据传输层级,提高开发效率,方便工作交接
  • java API接口文档

    2013-03-07 12:03:04
    API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。
  • API接口模板

    2019-01-21 11:19:27
    API接口模板,API接口文档模板,API接口模板,API接口模板,简单,但是很正规
  • Web接口文档模板.doc

    2020-02-29 18:46:37
    对于一些项目组内没有接口文档工具管理和平台,使用word编写web接口文档,方便而简洁,如果需管理,可以使用SVN统一管理,文档中有一个接口案例,可以直接套用。
  • API接口模板word/Excel

    2018-09-03 15:55:01
    API接口模板,word版本和Excel版本,用于平常的接口文档
  • 京东api接口文档

    2015-01-15 13:06:31
    为开发京东开放平台,自己整理的API接口文档,花了几天时间,文档是是PDF格式的,对各个接口进行了分门别类,带书签,方便京东开放平台二次开发的人员使用,制作很辛苦,收点分,不要介意,希望大家喜欢。
  • 所以api接口文档就变的十分有意义了,目前市场有哪些比较优秀的接口文档管理工具呢? 目录1.MinDoc2.eoLinker3.apizza4.RAML5.其他工具1.Swagger2.Showdoc3.apidoc4.RAP5.APIJSON6.易文档 1.MinDoc MinDoc 是一款...

    现在越来越流行前后端分离开发,使用ajax交互。所以api接口文档就变的十分有意义了,目前市场有哪些比较优秀的接口文档管理工具呢?

    1.MinDoc

    MinDoc 是一款针对IT团队开发的简单好用的文档管理系统。MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用,同时增加Markdown和HTML两种编辑器。其功能和界面源于 kancloud 。
    在这里插入图片描述

    主要功能:
    项目管理,可以对项目进行编辑更改,成员添加等。
    文档管理,添加和删除文档,文档历史恢复等。
    用户管理,添加和禁用用户,个人资料更改等。
    用户权限管理 , 实现用户角色的变更。
    项目加密,可以设置项目公开状态,私有项目需要通过Token访问。
    站点配置,二次开发时可以添加自定义配置项。
    附件管理,可管理所有项目中上传的文件。
    项目导出,目前支持导出 PDF 格式项目。
    系统日志。

    网址:https://www.iminho.me/

    2.eoLinker

    eoLinker拥有业内最强的接口管理功能,无论你是创业团队还是成熟企业,eoLinker将满足你的所有接口管理需求。在eoLinker上编写或者导入接口文档,邀请团队成员加入项目,接着进行在线的接口测试,并且提供Mock接口给前端进行对接,后续通过完善的文档版本管理以及团队协作功能,不断地对项目进行迭代,提高项目整体的开发效率!
    在这里插入图片描述

    主要功能:
    快速全面地管理接口文档 :
    1.UI可视化文档,
    2. 支持表单、RESTful、Raw等设计规范,
    3. 通过注释生成文档,
    4. 版本管理,
    5. 支持富文本/Markdown,
    6. 分组管理,
    7. 星标标注。
    测试接口是否正常运作:
    1. 支持在线、本地(localhost)测试,
    2. 支持跨域测试,
    3. 支持文件测试,
    4. 强大的参数构造器。
    Mock API实现敏捷开发:
    1. 根据文档自动生成校验数据,
    2. 支持请求协议、请求方式校验,
    3. 支持简易Mock、高级Mock(MockJS),
    4. 支持跨域调用。
    了解团队成员动向:
    1. 团队人员管理,
    2. 支持设置人员读写权限,
    3. 支持成员昵称,
    4. 支持通过链接邀请成员。
    专业版:
    1. 强大的插件支持,
    2. 代码生成,
    3. 测试用例,
    4. 空间日志,
    5. 高级权限管理,
    6. 5天 * 10小时 专业客户成功部门一对一支持。

    网址:https://www.eolinker.com/#/

    3.apizza

    极客专属的api协作管理工具 免费的团队协作,在线模拟调试,快速生成api文档,导出离线版文档
    在这里插入图片描述

    主要功能:
    api跨域调试量身定制的chrome插件,本地,在线接口,都可以调。
    免费的团队协作 免费的团队协作工具,极致的文档编写体验,加快开发效率。
    安全的云端存储 安全可靠的云端存储服务,企业安全版支持本地数据中心。
    一键分享 与团队共享你的API文档。
    支持Postman,Swagger格式 导入Postman/Swagger Json 生成文档。
    导出离线文档 导出离线文档,部署本地服务器。
    api Mock 根据文档自动生成返回结果,提供独立URL方便前端测试
    支持多种文档 http接口文档,markdown说明文档

    网址:http://apizza.cc/

    4.RAML

    用 YAML 文件格式编写,强大的官方支持,官方提供 atom 插件,支持语法智能提示及校验,编写快速简单。
    在这里插入图片描述

    主要功能:
    支持 examples
    支持 schema 校验
    支持工具测试

    网址:https://raml.org/

    5.其他工具

    1.Swagger

    通过固定格式的注释生成文档. 省时省力,不过有点学习成本。
    网址:https://swagger.io/

    2.Showdoc

    一个非常适合IT团队的在线API文档、技术文档工具。

    在这里插入图片描述
    网址:https://www.showdoc.cc/

    3.apidoc

    可以根据代码注释生成web api文档,web接口的注释维护起来更加方便,不需要额外再维护一份文档。
    网址:http://apidocjs.com/

    4.RAP

    一个可视化接口管理工具 通过分析接口结构,动态生成模拟数据,校验真实接口正确性, 围绕接口定义,通过一系列自动化工具提升我们的协作效率。
    网址:http://rap.taobao.org/org/index.do

    5.APIJSON

    客户端可以定义任何JSON结构去向服务端发起请求,服务端就会返回对应结构的JSON字符串,所求即所得。
    网址:http://jsonapi.org/

    6.易文档

    从需求文档、API文档、部署文档到使用手册,多种定制文档编辑器,满足您整个开发周期需求; 支持接口在线测试,一键生成文档、调用示例、mock配置。 极致的编写体验,优雅的排版,让文档成为一种乐趣。
    在这里插入图片描述
    主要功能:
    快速编写:常用参数一键引用,支持Json导入,一键生成文档、调用示例、Mock。
    支持导出、分享:可导出PDF、HTML、WORD、JSON;分享支持密码,失效时间。
    自定义模板:可灵活自定义文档结构,存为模板,定制专属模板。
    接口测试、Mock:在线接口测试,可把测试结果存为调用示例、一键生成文档。

    网址: https://easydoc.xyz/#/console 年收费720元/15人

    展开全文
  • 网站地址:https://www.showdoc.cc 第一步:注册 第二步:填写注册信息,这里填写用户名和密码即可,用户名不可重复,... ...也可以不注册查看示例决定要不要使用这个网站来写接口文档。...第五步:写API接口文档 ...

    网站地址:https://www.showdoc.cc

    第一步:注册

    第二步:填写注册信息,这里填写用户名和密码即可,用户名不可重复,注册登录后可以绑定邮箱。

    也可以不注册查看示例决定要不要使用这个网站来写接口文档。

    https://www.showdoc.cc/demo?page_id=9

    第三步:成功登录

    第四步:绑定邮箱

    第五步:写API接口文档

    插入API接口模板

    照着写

    还有其他功能就不一一说明了,自己摸索。

    展开全文
  • markdown来写API接口文档

    千次阅读 2019-03-19 17:01:00
    文章目录XX项目API接口文档通用说明:①接口通用前缀:② 接口通用返回:1 登录模块1.1 各移动端登录通用接口模板源码如下 通用说明: ①接口通用前缀: 测试环境: http://192.168.0.168:8081/wellLid 生产环境: ...

    如下显示效果

    XX项目API接口文档

    通用说明:

    ①接口通用前缀:

    测试环境: http://192.168.0.168:8081/wellLid

    生产环境: 待定

    ② 接口通用返回:

    {
        "code": "0000", // 正确码为0000 错误码为0001 
        "content": "", // 如发生错误此处会显示相关错误信息
        "result": { // 所有需要的结果集都会放在该对象中
            "id": 194,
            "token": "abb37e1dd94f47289f444b365e932707"
        }
    }
    

    1 登录模块

    1.1 各移动端登录通用接口

    • 说明

    提供测试的账号
    appType=2&userName=demo&passWord=123456

    • 请求URL

    /app/common/userLogin/getcheckUser.do

    • 请求方式

    POST

    • 请求参数
    请求参数必选参数类型说明
    appTypetrueIntegerAPP端类型 1管理端 2维修端 3安装端 4巡检端
    userNametrueString用户名
    passWordtrueString密码
    • 返回字段
    返回字段字段类型说明
    logKeyInteger随机生成的UUID可作为透传消息的唯一标识
    userCodeString用户ID
    • 返回示例
    // 正确示例
    {
        "content": "",
        "code": "0000",
        "result": {
            "logKey": "52893f69-54d7-4bfb-b64f-a68aa3b49de4",
            "userCode": "babc7737-e34d-45fc-b75f-dff35b8126e5"
        },
        "url": null
    }
    // 错误示例
    {
    	"content": "类型不存在!",
    	"code": "0001",
    	"result": null,
    	"url": ""
    }
    
    

    模板源码如下

    不知道咋能在markdown里面不编译部分markdown语法,所以上传一下加个下载链接了,下载地址如下:
    (资源分太贵可以加我QQ我发你931197485)
    下载地址:https://download.csdn.net/download/zbx931197485/11037962

    展开全文
  • 接口文档标准的模板,包含两种word、excel模板,希望对大家有帮助
  • 正确规范写api接口文档

    千次阅读 2019-06-06 10:28:59
    正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员的。一个工整的文档显得是非重要。 接口1 查询排重接口: 接口详情 请求地址 /api/user/login/ 请求方式 GET ...

    一.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。

    接口1 查询排重接口:
    
    接口详情
    请求地址/api/user/login/
    请求方式GET
    参数是否必填说明
    phone手机号码
    password密码
    返回结果说 明
    success返回登录状态,true–登录成功,flase–登录失败
    msg返回登录信息
    name用户名
    sessionId返回存入session的标识
    返回结果案例

    具体返回结果举例:

    {
    	"success": true,
    	"msg": "登录成功!",
    	"name": "test",
        "sessionId": "6cdf33e6-b037-4ddb-bdce-5158335ffd18",
    }
    {
    	"msg": "账号不存在",
    	"success": false
    }
    {
    	"msg": "密码错误",
    	"success": false
    }
    
    展开全文
  • 接口API文档

    千次阅读 2020-12-12 17:00:37
    应用程序的开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。 2.为什么要写接口文档? 1)项目开发过程中前后端工程师有一个统一的文件进行...
  • RESTFul API 接口说明

    2018-11-05 02:10:50
    restful api 接口说明. 总结 restful api 语法知识和常用的状态码含义.
  • 提供一些我自己使用过的api数据接口,让学习前端的朋友可以提早熟练地调用一些Api接口。 以下api数据接口主要为一些学过ajax或一些学过vue基础的同学。 第一个:网易云音乐的api数据接口, 基础访问地址(api的跟...
  • 直接先贴图(文中的url做了修改...@FeignClient(name = "Z_KPI_API",url = "${Z.KPI.url:http://11.11.111.111:8080}",fallback = ZApiClientFallback.class) public Interface ZApiClient{ @PostMapping(path = "...
  • 文档 是我用过最好用的在线接口文档管理工具,支持在线...只支持markdown编辑模式,写接口文档比较麻烦。不过支持文档打赏和评论。 小幺鸡 小幺鸡是专门http文档的,个人项目,以前也有用过,但是编辑体验不...
  • api模板文档

    2017-09-15 09:54:16
    接口模板,主要接口概述、接口路径设计、接口请求方式、接口返回数据规则,具体的接口要求有接口地址、协议、参数、接口说明、返回说明、返回格式
  • API接口入门:读懂API接口文档

    万次阅读 多人点赞 2019-10-23 13:54:06
    本文目录: API接口是什么? 为什么我们需要API接口API接口的核心 一、API接口是什么? 我们来以一个常见的数学公式理解API,比如y=x+2,当x=2的时候,y=4,对么?...API接口入门(一):读懂API接口文档 类...
  • 现在越来越流行前后端分离开发,使用ajax交互。所以api接口文档就变的十分有意义了,目前市场有哪些比较优秀的接口文档管理工具呢?1、MinDoc网址:https://www.iminh...
  • RabbitMQ API文档

    2016-02-24 15:05:52
    RabbitMQ实现了AMQP协议,RabbitMQ 3.5.6版本的API文档,欢迎下载使用
  • RESTFul API 接口文档模板

    万次阅读 多人点赞 2019-01-13 16:01:08
    修订记录 ...华为公有云 API 接口 https://support.huaweicloud.com/api-ecs/zh-cn_topic_0065792793.html https://support.huaweicloud.com/api-ecs/zh-cn_topic_0020805967.html ...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 423,771
精华内容 169,508
关键字:

根据api文档写接口