- 综合排序
- 最热优先
- 最新优先
- 来自专栏别先生
select2 api参数的文档
value is: "+$("#e1").select2("val"));}); // 获取选中的ID值 $("#e1").click(function () { $("#e2").select2(" (function () { $("#e2").select2("open"); }); // 打开下拉框 $("#e1").click(function () { $("#e2").select2(" "); }) // select2 打开事件 .on("select2-close", function() { log("close"); }) // select2 关闭事件 .on("select2 // 失去焦点事件 $("#e11").click(function() { $("#e11").val(["AK","CO"]).trigger("change"); }); 官网文档地址是 ：http://select2.github.io/select2/#documentation。
7.2K50发布于 2019-06-05 - 来自专栏Web前后端、全栈出发
Swagger2自动生产： api文档
SpringBoot整合Swagger2 api文档作用： api文档 想必大家都不陌生， 目前大多数, 互联网的项目，都是属于前后端分离的 ， 而，为了前后台更好的对接，还是为了以后交接方便，都有要求写 API文档。 记录各个接口api 的，作用，参数，请求方式… 可以避免开发的很多问题，提高效率的一种方式； 而，手写api文档，不可避免会有很多麻烦的的方： 文档需要更新的时候，需要再次发送一份给前端，也就是文档更新交流不及时 接口返回结果不明确 不能直接在线测试接口，通常需要使用工具，比如postman 接口文档太多，不好管理 Swagger也就是为了解决这个问题，可以不用在手动写api 文档，并且可以实时的更新！ 注释,并且实时生成api文档！
50310编辑于 2024-08-06 - 来自专栏全栈程序员必看
api接口文档html模板,开发接口文档-api文档模板
1、XXX项目接口文档版本控制信息版本日期描述作者V1.02018-8-13创建XXX1 获取所有字段1.1 获取所有字段请求地址：/session/field/findAll请求参数参数名必填字段类型描述 2、,id:7,name:XX,totals:02 文件上传2.1 文件上传(ajax)请求地址：/session/file/upload请求参数参数名必填字段类型描述file是FormDataFormData id=2&name=test响应例子：code:10000,exception:null,isSuccess:true,message:成功，系统处理正常！ id=2响应例子：code:10000,exception:null,isSuccess:true,message:成功，系统处理正常！,page:0,pageSize:0,returnList。 5、Size:0,returnObject:null,returnValue:id:2,name:re,totals:03.4 获取所属类型列表请求地址：/session/fieldType/selectAll
19.7K20编辑于 2022-09-15 - 来自专栏专注于主流技术和业务
使用Swagger2Markup实现导出API文档
但是，构建的文档必须通过在项目中整合swagger-ui、或使用单独部署的swagger-ui和/v2/api-docs返回的配置信息才能展现出您所构建的API文档。 本文将在使用Swagger的基础上，再介绍一种生成静态API文档的方法，以便于构建更轻量部署和使用的API文档。 Swagger使用说明：REST API文档工具Swagger2，以及与SpringBoot的集成 Swagger2Markup简介 Swagger2Markup是Github上的一个开源项目。 项目，REST API文档工具Swagger2，以及与SpringBoot的集成。 除了ASCIIDOC之外，还有MARKDOWN和CONFLUENCE_MARKUP from(new URL("http://localhost:8080/v2/api-docs")：指定了生成静态部署文档的源头配置
25.6K71发布于 2018-09-10 - 来自专栏米虫的家
SpringBoot之API--Swagger2接口文档管理
annotations.EnableSwagger2; /** * API接口文档配置 * * @Author MiChong * @Email: 1564666023@qq.com * @ 再通过createRestApi函数创建Docket的Bean之后，apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。 ，并产生文档内容（除了被@ApiIgnore指定的请求）。 3、添加文档内容 在完成了上述配置后，其实已经可以生产文档内容，但是这样的文档主要针对请求本身，而描述主要来源于函数等命名产生，对用户并不友好，我们通常需要自己增加一些说明来丰富文档内容。 如下所示，我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明。
63510发布于 2020-09-24 - 来自专栏腾讯云API
TEZ API 文档
TEZ API 文档 地域相关接口 接口名称 接口功能 频率限制（次/秒） DescribeRegions 查询地域列表 20 DescribeZones 查询可用区列表 20 实例相关接口 接口名称 DescribeNetworkInterfaces 查询弹性网卡列表 DetachNetworkInterface 弹性网卡解绑云服务器 MigrateNetworkInterface 弹性网卡迁移 如果源和目的网卡有属于 tez，则2者必须一致 MigratePrivateIpAddress 弹性网卡内网IP迁移 如果源和目的网卡有属于 tez，则2者必须一致 ModifyPrivateIpAddressesAttribute 修改弹性网卡内网
1.8K40编辑于 2023-07-31 - 来自专栏信数据得永生
django 1.8 官方文档翻译： 2-2-3 查找 API 参考
查找 API 参考 New in Django 1.7. 这篇文档是查找 API 的参考，Django 用这些API 构建数据库查询的WHERE 子句。 一个类如果想要成为查找，它必须实现查询表达式API。Lookup 和Transform一开始就遵循这个API。 这个类遵循查询表达式API，也就是说你可以使用 <expression>__<transform1>__<transform2>。 bilateral New in Django 1.8. 译者：Django 文档协作翻译小组，原文：Lookup expressions。 本文以 CC BY-NC-SA 3.0 协议发布，转载请保留作者署名和文章出处。 Django 文档协作翻译小组人手紧缺，有兴趣的朋友可以加入我们，完全公益性质。
89840编辑于 2022-11-27 - 来自专栏秃头哥编程
SpringBoot整合Swagger2，搭建Restful API在线文档
世间上的相遇 都是久别重逢 Swagger是一个功能强大的在线API文档框架，目前它的版本是2.x，所以称为Swagger2。Swagger2提供了在线文档的查阅和测试功能。 3、生成文档的注解 Swagger2通过注解来生成API接口文档，文档信息包括接口名、请求方法、参数、返回信息等。 通常情况下用于生成在线API文档，下面是常见的注解： @Api：修饰整个类，用于描述Controller。 @ApiOperation：描述类的方法，或者说一个接口。 API的说明，其中value值为该接口的名称，note为该接口的详细文档说明。 这样就可以让Swagger2生成在线的API接口文档了，如果不需要某接口生成文档，只需要加上@ApiIgnore注解即可。
81830发布于 2019-10-09 - 来自专栏全栈程序员必看
springboot使用swagger2生成api文档
之前开发项目的时候，需要写API文档，项目小接口少的时候一份word就能简单应付，但是随着项目的API的增加，对API文档的维护工作就会越来越繁琐，为此引入能自动生成RESTful接口文档的Swagger2 作为一个能够自动生成API文档的框架，其最大的优点有两个： 接口文档在线能够自动生成，文档随接口变动实时更新，节省维护成本 支持类似spring RESTful插件那样的在线接口测试，不依赖第三方工具 //下同，不再赘述 } 启动项目后访问特定页面即可看到以Controller分类的API文档，点击展开以，根据注解的详细程度，会有传入参数，返回类型等详细说明，除此之外，还会有类似springREST插件那样的在线测试功能 ws， wss hidden 默认为false， 配置为true 将在文档中隐藏 实例： @Api(value = "Api-test", tags = "测试接口") @RequestMapping knife4j是为JavaMVC框架集成Swagger生成Api文档的增强解决方案 ，在Swagger的基础上进行了各方面的增强，比如接口排序，一键导出markdown，word，pdf等功能，以及一个逻辑更加清晰而美观的功能
99210编辑于 2022-09-23 - 来自专栏Elton的技术分享博客
整合cocos2d API文档到XCode中
cocos2d是经常使用的iOS游戏引擎，在编写代码的时候，经常需要参考它的API文档，本文主要介绍如何将cocos2d的文档整合到XCode中。 设置doxygen 修改doxygen.config文件，将HAVE_DOT设置成YES，将DOT_PATH设置成/usr/local/graphviz-x.y/bin 选择cocos2d-documentation target 打开 cocos2d-iphone的xcode项目工程 选择 “cocos2d-documentation” target XCode -> Project -> Set Active Target -> cocos2d-documentation 生成项目 像生成其他项目一样生成此项目 XCode -> Build -> Build 之后就可以在文档中查看cocos2d文档了。
94640发布于 2021-01-26 - 来自专栏全栈程序员必看
swagger2导出api为word文档（java实现）
2，按照java面向对象思路分析，上述表格即为一个接口（一个单元），一共三个对象：Table.java、Request.java、Response.java。 3，将原始swagger2的json数据进行解析、封装成上述三个java对象，然后再通过html渲染即可形成web版API文档。 4，将web版API文档另存为doc文件，即生成了api-doc文件。 文档 将第二部中生成的封装后的json数组赋值给tableList，table()方法会在html加载时进行页面渲染。 在浏览器中打开table.html即可看到web版API文档； 5、将页面另存为doc文件，结束！
11.5K10编辑于 2022-11-16 - 来自专栏全栈程序员必看
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进行地图开发的朋友，可以参考这个文档。 内容就不发到这里了，因为放上来格式会有点乱，所以放在别处了。
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 - 来自专栏一个会写诗的程序员的博客
Spring Boot中使用 Swagger2 自动构建API文档
Swagger2 https://github.com/swagger-api/swagger-ui 提供了强大的页面测试功能来调试每个RESTful API。具体效果如下图所示： ? 构建RESTful API 在使用Swagger2前我们需要有一个RESTful API的项目. 自动构建API文档") .description("API文档") .version("1.0") .build 再通过createRestApi函数创建Docket的Bean之后，apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。 本例采用指定扫描的包路径来定义，Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）。 ---- Kotlin开发者社区 ?
1K20发布于 2020-07-22 - 来自专栏Lambda
Spring-Boot + Swagger2 自动生成API接口文档
在实际开发过程中，这些接口还要提供给开发测试进行相关的白盒测试，那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题。 假如你已经对传统的wiki文档共享方式所带来的弊端深恶痛绝，那么尝试一下Swagger2 方式，一定会让你有不一样的开发体验： 功能丰富 ：支持多种注解，自动生成接口文档界面，支持在界面测试API接口功能 ； 及时更新 ：开发过程中花一点写注释的时间，就可以及时的更新API文档，省心省力； 整合简单 ：通过添加pom依赖和简单配置，内嵌于应用中就可同时发布API接口文档界面，不需要部署独立服务。 层，将详尽的API接口输入输出在代码中通过注解进行相关描述，下面给出一个接口描写示例，具体的写法可以参考其api文档的具体说明： 代码块 @Api(value = "PageController", description 通过该界面，不仅可以看到自动生成的所有API文档信息，还可以对任意接口进行在线测试，非常方便：
97120编辑于 2022-04-13 - 来自专栏JavaPark
Spring Boot 集成 Swagger2，构建强大的 API 文档
而通俗地讲，Swagger 就是帮我们写接口文档的。它不仅能自动生成实时接口文档，还能生成测试用例，方便我们进行测试。 public class Swagger2Configuration { /** * 配置 Swagger 2 * 注册一个 Bean 属性 * enable() ：是否启用 Swagger，启用后才能在浏览器中进行访问 * groupName()：用于配置 API 文档的分组 */ @Bean public Docket docket package com.cunyu.springbootswaggerdemo.controller; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation qq.com * @微信 : cunyu1024 * @公众号 : 村雨遥 * @网站 : https://cunyu1943.github.io * @description : */ @Api
82910编辑于 2022-01-19 - 来自专栏信数据得永生
django 1.8 官方文档翻译：5-1-2 表单API
表单 API 关于这篇文档 这篇文档讲述Django 表单API 的详细细节。你应该先阅读表单简介。 绑定的表单和未绑定的表单 表单要么是绑定的，要么是未绑定的。 'extra_field_2': 'bar', ... 其__str__()（Python 2 上为__unicode__）方法显示该字段的HTML。 ，原文：Form API。 Django 文档协作翻译小组人手紧缺，有兴趣的朋友可以加入我们，完全公益性质。
3.5K30编辑于 2022-11-27 - 来自专栏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.6K30发布于 2020-12-10
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号