- 综合排序
- 最热优先
- 最新优先
- 来自专栏浅枫沐雪
3秒集成API接口文档
--Api Doc--> <dependency> <groupId>io.github.yedaxia</groupId> <artifactId config.setProjectName("office-website-java"); // 项目名称 config.setApiVersion("V1.0"); // 声明该API 的版本 config.setDocsPath("D:\\apiDoc"); // 生成API 文档所在目录 config.setAutoGenerate(Boolean.TRUE ); // 配置自动生成 Docs.buildHtmlDocs(config); // 执行生成文档 启动项目 在ApiDoc输出目录V1.0里面的index.html打开即可看到类似下图的接口文档 [接口文档.png] 更多详见 https://japidocs.agilestudio.cn/#/zh-cn/
1.4K30发布于 2020-12-09 - 来自专栏信数据得永生
django 1.8 官方文档翻译： 3-3-3 文件储存API
文件储存API 获取当前的储存类 Django提供了两个便捷的方法来获取当前的储存类： class DefaultStorage[source] DefaultStorage 提供对当前的默认储存系统的延迟访问 get_storage_class([import_path=None])[source] 返回实现储存API的类或者模块。 Storage类 class Storage[source] Storage类为文件的存储提供了标准化的API，并带有一系列默认行为，所有其它的文件存储系统可以按需继承或者复写它们。 译者：Django 文档协作翻译小组，原文：Storage API。 本文以 CC BY-NC-SA 3.0 协议发布，转载请保留作者署名和文章出处。 Django 文档协作翻译小组人手紧缺，有兴趣的朋友可以加入我们，完全公益性质。
73530编辑于 2022-11-27 - 来自专栏全栈程序员必看
api接口文档html模板,开发接口文档-api文档模板
1、XXX项目接口文档版本控制信息版本日期描述作者V1.02018-8-13创建XXX1 获取所有字段1.1 获取所有字段请求地址：/session/field/findAll请求参数参数名必填字段类型描述 3、应例子：returnValue里包含了 fileName和filePath3 字段管理-所属类型3.1 新增所属类型请求地址：/session/fieldType/save请求参数参数名必填字段类型描述
19.7K20编辑于 2022-09-15 - 来自专栏腾讯云API
TEZ API 文档
TEZ API 文档 地域相关接口 接口名称 接口功能 频率限制（次/秒） DescribeRegions 查询地域列表 20 DescribeZones 查询可用区列表 20 实例相关接口 接口名称
1.8K40编辑于 2023-07-31 - 来自专栏JavaPark
Spring Boot 使用 Swagger3 生成 API 接口文档
文档[1]。 支持 OpenApi 3.0.3 兼容 Swagger2 的注释，而且进一步丰富了 open API 3.0 的规范 支持 Webflux 既然 Swagger3 有了这么多的改变，那用法是不是还和 Swagger2 测试", "Spring Boot 集成 Swagger3 测试接口文档", "v1.0", "https 文档摘要信息（Docket）文件类型不同，可以发现在 Swagger 的配置类中，Swagger2 用的是 SWAGGER_2，而 Swagger3 中则用的是 OAS_3； Swagger UI 访问地址不同 文档: https://blog.csdn.net/github_39655029/article/details/122336225 [2]创建 Spring Boot 项目的 3 种方式: https
29.6K22编辑于 2022-01-19 - 来自专栏全栈程序员必看
api数据接口文档_接口文档示例
本文主要是提供了一个接口文档的范文，内容修订历史、目录、时序图、接口要素描述、接口说明、使用示例、字典、FAQ。 使用MD格式文档（makedown），选择原因，容易格式转换，开发便于修改，版本维护界面，修改记录明显，普通文本工具即可编辑。 下方是接口文档的示例： **API说明** ## 修订历史 | 日期 | 内容 本文档用于XXX业务的接口说明和使用说明。 –> API: 登录成功 API -> APISERVER: 业务请求 APISERVER –> API: 业务响应 API -> APISERVER: …… APISERVER –> API
4.3K20编辑于 2022-11-15 - 来自专栏全栈程序员必看
FGMap API 帮助文档
FGMap API 帮助文档，如果需要用FGMap API进行地图开发的朋友，可以参考这个文档。 内容就不发到这里了，因为放上来格式会有点乱，所以放在别处了。 svn/trunk/help/help.html 接口库地址是：http://fgmap-webgis.googlecode.com/svn/trunk/debug/FGMapLib.zip 2012-3-
1.6K50发布于 2021-08-12 - 来自专栏python3
python查看api文档
python –m pydoc –p 1234 浏览器中访问http://localhost:1234/ 就可以打开python及集成的其他库的api
1.5K10发布于 2020-01-09 - 来自专栏玩转JavaEE
elasticsearch文档Delete API
上篇文章和读者分享了Elasticsearch中文档Get API的一些基本用法，本文来看看DELETE API的基本用法。 本文是Elasticsearch系列的第十一篇，阅读前面的文章，有助于更好的理解本文： ---- 1.elasticsearch安装与配置 2.初识elasticsearch中的REST接口 3.elasticsearch 修改数据 4.elasticsearch文档操作 5.elasticsearch API约定(一) 6.elasticsearch API约定(二) 7.elasticsearch文档读写模型 8.elasticsearch 文档索引API(一) 9.elasticsearch文档索引API(二) 10.elasticsearch文档 Get API ---- Delete API允许开发者通过一个文档id删除一个JSON文档 Wait For Active Shards waitforactive_shards参数的作用和elasticsearch文档索引API(二)一文中介绍的含义一致，这里不再赘述，读者可以参考该篇文章。
1.7K10发布于 2018-12-24 - 来自专栏TensorFlow从0到N + Rust
Rust API 指南：文档
原文：Rust API Guidelines chapter 4 Crate级别的文档应非常详尽，并包含示例（C-CRATE-DOC） 见RFC1687. 仅在有唯一的网站而不是代码库或API文档的情况下设置homepage元数据。不要使用documentation或repository值填充homepage。 target=https%3A//crates.io/crates/version-sync)的crate可以帮助您解决此问题，方法是让您添加一个集成测试，如果html_root_url版本号与crate 例如，如果根模块的文档位于"https://api.rocket.rs/rocket/index.html"，则html_root_url将为"https://api.rocket.rs"。 target=https%3A//github.com/rust-lang/rfcs/blob/master/text/1422-pub-restricted.md) 是另一个用于从公共API删除实现细节的好工具
2.6K30发布于 2020-12-10 - 来自专栏玩转JavaEE
elasticsearch文档Update API
通过前面两篇文章的阅读，相信读者已经熟练掌握 DeleteByQuery的用法了，本文则来继续看文档的Update API。 本文是Elasticsearch系列的第十四篇，阅读前面的文章，有助于更好的理解本文： ---- 1.elasticsearch安装与配置 2.初识elasticsearch中的REST接口 3.elasticsearch 修改数据 4.elasticsearch文档操作 5.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允许开发者根据脚本更新文档
2.2K20发布于 2019-03-07 - 来自专栏快乐阿超
postman导出api文档
——罗曼·罗兰 postman官网下载地址 点击postman的new 选择API Documentation 你可以创建一个集合 或者选择一个已有集合 编写描述 然后点击Save 点击生成的链接就可以看到了
3K20编辑于 2022-08-16 - 来自专栏大话swift
自动生成API文档
对于我们App开发人员来说，API那就是生命中的血液，每日都在在我们的App中穿插流淌，但是对于API的数据测试和预览管理那是十分头疼的一件事情，那么问题来了？ 今天就来个干货帮咱们完成这个东东……下次服务端的童靴再不好好写API的时候就把这个砸他脸就成…… ? return new ApiInfoBuilder() .title("Swagger2 ") .description("使用Swagger2做API 帮助文档查看 swagger
2.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.6K20发布于 2018-12-21 - 来自专栏墨画
墨画API接入文档
墨画API目前已经发布了 链接生成二维码API 与 发送邮件API ，为什么只有这两个呢？ emmm...我们不知道还要搭什么了，有想法的可以在下方评论区或在建议与反馈中提出来这两个api都比较简单哈生成二维码API接入：接入代码：<imgsrc="https://<em>api</em>.mohuajz.top text=https://mohuajz.top/&size=200">发送邮件API接入：接入代码：<a href=“https://api.mohuajz.top/mail/api.php? adress=收件人邮箱地址&title=发信标题&content=邮件内容”>随便你说明：1.adress 收件人邮箱地址2.tittle 发信标题3.content 发信内容返回数据：发送成功 /mail/api.php?
761101编辑于 2023-01-01 - 来自专栏python3
API文档管理平台
一、应用场景 在公司中，有很多开发，每个人维护的api接口是不一样的。如果有一个统一的api文档管理平台，每个开发，把自己维护的接口录入进去。 关于api文档管理，网上有很多。有在线收费的，也有开源的。基于节省成本考虑，这里主要介绍2个开源工具：ShowDoc和YApi。 下面会详细介绍着2个工具的使用方法，都是基于docker安装的！ 二、ShowDoc ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册。 点击插入API接口模板，点击右侧的保存 可以看出，左边就是markdown格式，右边就是预览效果 ? 保存之后，点击返回，效果如下： ? ok，到这里，一个api文档就完成了。 确保已经安装了以下2个模块 pip3 install Django pip3 install djangorestframework 新建项目untitled ?
5.6K20发布于 2020-01-15 - 来自专栏迁移内容
SpringBoot实战：整合Swagger3实现在线Api文档
本篇就是实现 SpringBoot 整合 Swagger3 实现在线 Api 文档。 Swagger3 API 文档的配置 package com.lizhengi.config; import org.springframework.beans.BeansException; import API 文档的配置 * @date 2022-12-09 03:12 上午 **/ @Configuration public class Swagger3Config { /** * API 文档信息 * * @return - */ @Bean public Docket api() { // 自动生成文档接口：http ://localhost:8080/v3/api-docs // API接口文档界面：http://localhost:8080/swagger-ui/index.html
2K30编辑于 2022-12-11 - 来自专栏Linyb极客之路
API文档先行还是API编码先行？
API文档先行是在编码之前先设计好API说明，Swagger提供Open API规范的文档范式，可通过IDE插件或Swagger网站提供的在线编辑工具编辑。 API文档先行 前面演示的流程其实是API文档先行，先使用工具编制好API文档，然后生成代码说明模板，在这个模板上再进行详细编码，这样做的好处能够重点设计好API内容，不会被编码细节打扰，坏处是，在详细编码中如果需要调整一些入参和出参 ，需要改文档，再该代码里面的API文档，比较麻烦。 API编码先行 这是传统直觉方式，把API文档看成是普通文档，写好代码再写文档，其实在REST前后端分离架构下，如果写好API文档，前后端可以同时进行开发，而且提供前端人员对你的API测试的依据，对项目演进过程中如果代码有变动 ，而API文档没有修改，导致功能都无法正常运行。
1.6K30发布于 2018-10-24 - 来自专栏python与大数据分析
Flask搭建api服务-生成API文档
前面讲到了Flask实现api，但api是给别人用的，就要告诉别人如何发现api，以及api的用途、名称、出参、入参，生成api文档的做法有好多种，本文选了一种最简单的方式。 核心就是通过app.view_functions 这个字典找到每个API 的endpoint所绑定的方法，然后访问方法的名字和文档即可 从路由中搜索api，在这里可以构筑规则 def get_api_map , api_map contains each api url + endpoint.""" format(endpoint) return render_template('api_docs.html', api=api) 获取api的名称和api文档内容 def _get_api_name > {% endblock %} api首页的页面如下： 具体api的像个文档 最后，谢谢关注，谢谢支持！
2.8K20编辑于 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.4K11编辑于 2022-03-29
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号