首页
学习
活动
专区
圈层
工具
发布
    • 综合排序
    • 最热优先
    • 最新优先
    时间不限
  • 来自专栏全栈程序员必看

    api接口文档html模板,开发接口文档-api文档模板

    1、XXX项目接口文档版本控制信息版本日期描述作者V1.02018-8-13创建XXX1 获取所有字段1.1 获取所有字段请求地址:/session/field/findAll请求参数参数名必填字段类型描述 villages:null,companys:iconColour:,iconSize:0,iconStyle:,id:4,name:XX,iconColour:,iconSize:0,iconStyle:,id:5, 5、Size:0,returnObject:null,returnValue:id:2,name:re,totals:03.4 获取所属类型列表请求地址:/session/fieldType/selectAll

    19.3K20编辑于 2022-09-15
  • 来自专栏服务器运维笔记

    5分钟打造好用好看API文档

    对接第三方开放平台文档的时候,左手刷着接口文档API,右手操作着接口调试工具 写完接口想交付或提供API文档给第三方使用,又觉得文档展示体验一般?很鸡肋? 通过文档在线调试,进一步提升开发者对接开放平台API的效率。 该平台目前已经聚合了大部分主流第三方开放API 换句话说通过Apifox赋能的开放API文档都是具备在线调试、代码生成 。 可以的,5分钟教你搞定! CNAME到你域名厂商的配置中心 最后发布通过你自定义的接口文档,也可以申请发布到上文提到的API Hub中 完成上述操作,你将会收获一个好用好看API文档 API文档是支持在线调试的 域名是你自定义的 「最后」 API文档功能只是Apifox强大功能中冰上一角,还提供了API调试、API Mock、API自动化测试等功能 官网地址:apifox.cn 图片

    69930编辑于 2022-11-02
  • 来自专栏腾讯云API

    TEZ API 文档

    TEZ API 文档 地域相关接口 接口名称 接口功能 频率限制(次/秒) DescribeRegions 查询地域列表 20 DescribeZones 查询可用区列表 20 实例相关接口 接口名称

    1.4K40编辑于 2023-07-31
  • 来自专栏LNMP开发那些事

    基础API指南 - 集成方法 - 构建文档 - ckeditor 5中文文档

    editor – Balloon编辑器 Document editor – Decoupled编辑器 文档中的大多数例子使用Classic编辑器,其他的构建版本使用方法与此一致。 请参阅每个编辑器的文档以了解详细信息。 编辑器类的接口也不是强制的。 由于编辑器的不同实现在功能方面可能有很大差异,因此编辑器类实现者可以完全自由地使用API。 与编辑器交互 创建编辑器后,可以通过其API与其进行交互。 上面例子中的编辑器变量应该启用它。 监听修改 Document#change:data 当文档以编辑器数据中“可见”的方式更改时,将触发此事件。 CKEditor 提供了丰富的API与剪辑器交互。获取更多信息请查阅API文档

    3.2K30发布于 2019-07-31
  • 来自专栏信数据得永生

    django 1.8 官方文档翻译:5-1-2 表单API

    表单 API 关于这篇文档 这篇文档讲述Django 表单API 的详细细节。你应该先阅读表单简介。 绑定的表单和未绑定的表单 表单要么是绑定的,要么是未绑定的。 我们将在这篇文档的后面将是编码的影响。 如果你的数据没有 通过验证,cleaned_data 字典中只包含合法的字段: >>> data = {'subject': '', ... name:</label> <input type="text" name="father-last_name" id="id_father-last_name" />

  • 译者:Django 文档协作翻译小组 ,原文:Form API。 Django 文档协作翻译小组人手紧缺,有兴趣的朋友可以加入我们,完全公益性质。

3.3K30编辑于 2022-11-27
  • 来自专栏玩转JavaEE

    elasticsearch文档Delete API

    上篇文章和读者分享了Elasticsearch中文档Get API的一些基本用法,本文来看看DELETE API的基本用法。 5.elasticsearch API约定(一) 6.elasticsearch API约定(二) 7.elasticsearch文档读写模型 8.elasticsearch文档索引API(一) 9. elasticsearch文档索引API(二) 10.elasticsearch文档 Get API ---- Delete API允许开发者通过一个文档id删除一个JSON文档,这个我们在前面已经有过案例 这里是将其设置为5分钟的一个示例: 执行删除操作时,分配用于执行删除操作的主分片可能不可用,原因可能是主分片当前正在从仓库恢复或正在进行重定位。 timeout=5m" 好了,本文就先介绍到这里,有问题欢迎留言讨论。

    1.6K10发布于 2018-12-24
  • 来自专栏全栈程序员必看

    api数据接口文档_接口文档示例

    本文主要是提供了一个接口文档的范文,内容修订历史、目录、时序图、接口要素描述、接口说明、使用示例、字典、FAQ。 使用MD格式文档(makedown),选择原因,容易格式转换,开发便于修改,版本维护界面,修改记录明显,普通文本工具即可编辑。 下方是接口文档的示例: **API说明** ## 修订历史 | 日期 | 内容 本文档用于XXX业务的接口说明和使用说明。 –> API: 登录成功 API -> APISERVER: 业务请求 APISERVER –> API: 业务响应 API -> APISERVER: …… APISERVER –> API

    3.7K20编辑于 2022-11-15
  • 来自专栏全栈程序员必看

    FGMap API 帮助文档

    FGMap API 帮助文档,如果需要用FGMap API进行地图开发的朋友,可以参考这个文档。 内容就不发到这里了,因为放上来格式会有点乱,所以放在别处了。

    1.5K50发布于 2021-08-12
  • 来自专栏python3

    python查看api文档

    python –m pydoc –p 1234 浏览器中访问http://localhost:1234/ 就可以打开python及集成的其他库的api

    1.4K10发布于 2020-01-09
  • 来自专栏大话swift

    自动生成API文档

    对于我们App开发人员来说,API那就是生命中的血液,每日都在在我们的App中穿插流淌,但是对于API的数据测试和预览管理那是十分头疼的一件事情,那么问题来了? 今天就来个干货帮咱们完成这个东东……下次服务端的童靴再不好好写API的时候就把这个砸他脸就成…… ? return new ApiInfoBuilder() .title("Swagger2 ") .description("使用Swagger2做API 帮助文档查看 swagger

    2K20发布于 2019-07-03
  • 来自专栏玩转JavaEE

    elasticsearch文档Get API

    前面两篇文章和读者讨论了Elasticsearch中文档的索引API,本文来看Get API。 ---- Get API是一个基于文档id,从索引中获取JSON文档API,例如如下请求表示从twitter索引中获取一个id为1的索引: curl -X GET "localhost:9200/twitter Realtime 默认情况下,Get API是实时的,并且不受index刷新率的影响(当数据对搜索可见时)。 如果文档已更新但尚未刷新,则Get API将发出刷新调用以使文档可见,这也会导致其他文档发生变化。如果开发者想要禁用实时GET,可以将realtime参数设置为false。 Routing 开发者如果在创建索引时指定了路由,那么在获取文档时也应该指定正确的路由,如果路由设置不一致将获取不到文档。具体可以参考上篇文章,这里不再赘述。

    1.5K20发布于 2018-12-21
  • 来自专栏TensorFlow从0到N + Rust

    Rust API 指南:文档

    原文:Rust API Guidelines chapter 4 Crate级别的文档应非常详尽,并包含示例(C-CRATE-DOC) 见RFC1687. 仅在有唯一的网站而不是代码库或API文档的情况下设置homepage元数据。不要使用documentation或repository值填充homepage。 比如,serde将homepage设置为专用网站https://serde.rs Crate设置html_root_url属性(C-HTML-ROOT) 假设crate使用docs.rs作为其主要API 没有它,依赖于您的crate的crate文档中的链接将不正确。 #! 例如,如果根模块的文档位于"https://api.rocket.rs/rocket/index.html",则html_root_url将为"https://api.rocket.rs"。

    2.4K30发布于 2020-12-10
  • 来自专栏快乐阿超

    postman导出api文档

    ——罗曼·罗兰 postman官网下载地址 点击postman的new 选择API Documentation 你可以创建一个集合 或者选择一个已有集合 编写描述 然后点击Save 点击生成的链接就可以看到了

    2.7K20编辑于 2022-08-16
  • 来自专栏玩转JavaEE

    elasticsearch文档Update API

    通过前面两篇文章的阅读,相信读者已经熟练掌握 DeleteByQuery的用法了,本文则来继续看文档的Update API5.elasticsearch API约定(一) 6.elasticsearch API约定(二) 7.elasticsearch文档读写模型 8.elasticsearch文档索引API(一) 9. elasticsearch文档索引API(二) 10.elasticsearch文档Get API 11.elasticsearch文档Delete API 12.elasticsearch文档Delete By Query API(一) 13.elasticsearch文档Delete By Query API(二) ---- Update API Update API允许开发者根据脚本更新文档,这个操作首先会从索引中获取文档 Updates with a partial document 更新文档API还支持将部分文档合并到现有文档中(简单的递归合并、对象内部合并、替换核心key/value以及数组),要替换整个文档,可以使用前文提到的

    2K20发布于 2019-03-07
  • 来自专栏python3

    API文档管理平台

    一、应用场景 在公司中,有很多开发,每个人维护的api接口是不一样的。如果有一个统一的api文档管理平台,每个开发,把自己维护的接口录入进去。 关于api文档管理,网上有很多。有在线收费的,也有开源的。基于节省成本考虑,这里主要介绍2个开源工具:ShowDoc和YApi。 下面会详细介绍着2个工具的使用方法,都是基于docker安装的! 二、ShowDoc ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册。 点击插入API接口模板,点击右侧的保存 可以看出,左边就是markdown格式,右边就是预览效果 ? 保存之后,点击返回,效果如下: ? ok,到这里,一个api文档就完成了。 本文参考链接: https://www.jianshu.com/p/a97d2efb23c5 

    5.3K20发布于 2020-01-15
  • 来自专栏墨画

    墨画API接入文档

    墨画API目前已经发布了 链接生成二维码API 与 发送邮件API ,为什么只有这两个呢? emmm...我们不知道还要搭什么了,有想法的可以在下方评论区或在建议与反馈中提出来这两个api都比较简单哈生成二维码API接入:接入代码:<imgsrc="https://<em>api</em>.mohuajz.top 示例:生成一张大小为200px,内容为https://mohuajz.top的二维码<imgsrc="https://api.mohuajz.top/qr/? text=https://mohuajz.top/&size=200">发送邮件API接入:接入代码:<a href=“https://api.mohuajz.top/mail/api.php? /mail/api.php?

    690101编辑于 2023-01-01
  • 来自专栏Linyb极客之路

    API文档先行还是API编码先行?

     API文档先行是在编码之前先设计好API说明,Swagger提供Open API规范的文档范式,可通过IDE插件或Swagger网站提供的在线编辑工具编辑。    API文档先行   前面演示的流程其实是API文档先行,先使用工具编制好API文档,然后生成代码说明模板,在这个模板上再进行详细编码,这样做的好处能够重点设计好API内容,不会被编码细节打扰,坏处是,在详细编码中如果需要调整一些入参和出参 ,需要改文档,再该代码里面的API文档,比较麻烦。 API编码先行  这是传统直觉方式,把API文档看成是普通文档,写好代码再写文档,其实在REST前后端分离架构下,如果写好API文档,前后端可以同时进行开发,而且提供前端人员对你的API测试的依据,对项目演进过程中如果代码有变动 ,而API文档没有修改,导致功能都无法正常运行。

    1.5K30发布于 2018-10-24
  • 来自专栏python与大数据分析

    Flask搭建api服务-生成API文档

    前面讲到了Flask实现api,但api是给别人用的,就要告诉别人如何发现api,以及api的用途、名称、出参、入参,生成api文档的做法有好多种,本文选了一种最简单的方式。 核心就是通过app.view_functions 这个字典找到每个API 的endpoint所绑定的方法,然后访问方法的名字和文档即可 从路由中搜索api,在这里可以构筑规则 def get_api_map format(endpoint) return render_template('api_docs.html', api=api) 获取api的名称和api文档内容 def _get_api_name \u671f\\u5c42\\u7ea7\", "dimcode": "01", "dimname": "\\u5e74\ > {% endblock %} api首页的页面如下: 具体api的像个文档 最后,谢谢关注,谢谢支持!

    2.4K20编辑于 2022-07-07
  • 来自专栏科控自动化

    Apifox ----API 文档API 调试、API Mock、API 自动化测试

    https://www.apifox.cn/ 功能特性 API 文档设计 可视化 API 文档管理,零学习成本。 支持数据模型,接口之间可以复用相同数据结构。 接口文档完全遵循 OpenAPI(Swagger) 规范。 支持在线分享 API 文档,方便与外部团队协作。 自动校验数据结构:校验返回的数据结构是否符合文档定义,自动发现接口数据异常。 可视化的断言、提取变量、数据库(SQL)操作等功能。 支持接口用例功能(一个接口多个用例)。 API 数据 Mock 零配置即可 mock 出非常人性化的数据(根据 API 文档智能 mock)。 支持读取数据库数据,用来校验(断言) API 请求是否成功。 自动生成代码 根据接口/模型定义,自动生成各种语言/框架的业务代码和 API 请求代码。

    5.2K11编辑于 2022-03-29
  • 来自专栏玩转JavaEE

    elasticsearch文档索引API(二)

    上篇文章和读者讨论了Elasticsearch中文档的索引API、自动创建索引、版本控制以及操作类型等问题,本文我们继续上文的话题,来看看文档索引的其他知识点。 Noop Updates 当使用索引API更新文档时,即使文档没有更改,也始终创建新版本的文档。如果这不可接受,请使用将 detectnoop设置为true的update API 。 此选项在索引API上不可用,因为索引api无法提取旧的文档,当然也无法和新的文档进行比较,具体用法如下图: ? 以下是将其设置为5分钟的示例: curl -X PUT "localhost:9200/twitter/_doc/1? timeout=5m" -H 'Content-Type: application/json' -d' { "user" : "kimchy", "post_date" : "2009-

    1.1K30发布于 2018-12-17
  • 领券