1 前置信息

产品手册，一般会撰写API文档，关于API文档编写，一般包括几个方面：API调用方式、具体URL、入参及出参等。

此次关于调用示例选用方式为curl，curl 是一种命令行工具，作用是发出网络请求，然后获取数据，显示在"标准输出"（stdout）上面。它支持多种协议。

curl 默认的 HTTP 动词是 GET

-X 参数可以支持其他动词。
--user name:password ，如果需要认证，可按照这种方式输入用户密码
-d, --data DATA     HTTP POST data (H)
-H, --header LINE   Custom header to pass to server (H)
-o, --output FILE   Write output to <file> instead of stdout

2 具体模板

## XX导入导出对于资源发布的需求，可以使用本节介绍的导入导出功能支持。目前，仅支持一个XX的导入和导出。### 前提条件您的 ** XX 版本必须 >= 1.1.0**### 导出- `POST  http://host:port/api/xx/export/{type}`- URL Path Variable- `type`: 取值为 `xx` - Basic Auth 认证
- `Content-Type`: `application`/ `json`
- HTTP Body 是 `json`，内容如下：- `{ "project":"[项目名]","dataset_name":"[数据集名称]" }`- Curl示例如下：```sh
curl -XPOST \
--user [用户名]:[密码] http://host:port/api/xx/export/{datasetType} \
-H 'Content-Type:application/json;charset=utf8' \
-d '{"project":"learn_kylin","dataset_name":"dataset1"}' \
-o export_dataset.json
```> 命令解释：调用接口，将相应的 json 数据存入到当前目录的export_dataset.json 中

产品手册API文档模板相关推荐

FreeMarker中文帮助手册API文档,基础入门学习文档
FreeMarker中文帮助手册API文档,基础入门学习文档分类: 编程技术发布: bywei 浏览: 7 日期: 2011年5月28日分享到: QQ空间新浪微博腾讯微博人人网什么是Fr ...
Apikit 自学日记:API 文档模板
我们可以通过创建API文档模板,并使用API文档模板来添加API文档,用于实现提高API文档创建效率,规范API文档格式的目的. 该功能是付费版本功能,需要升级为企业版方可使用. 创建API文档模板 ...
产品需求报告文档模板
状态 : [ √] 草稿 [] 修改中 [ ] 定稿文件标签: 产品需求文档.XXX 版本: 作者: 日期: 编辑历史文件名称: XXX 产品需求文档文件说明: 编辑历史: 编辑时间版本作 ...
如何编写优质的API文档
编写技术文档,是令众多开发者望而生畏的任务之一.它本身是一件费时费力才能做好的工作.可是大多数时候,人们却总是想抄抄捷径,这样做的结果往往非常令人遗憾的,因为优质的技术文档是决定你的项目是否引人关注的 ...
一份很不错的敏捷产品需要文档模板
敏捷误区:敏捷并不意味着不需要文档在敏捷的过程中,会有一种叫做产品需要设计文档的东东,简称PRD.最近在一次公司组织的内部培训会上,老师提供了一份PRD文档的模板,个人觉得这个PRD模板比较轻量,现 ...
如何撰写产品需求文档_需求文档模板（产品功能类需求篇）
前言需求文档在产品整个开发过程中至关重要,设计根据需求考虑交互功能.需求沟通评审和开发.测试验收标准.文档知识沉淀问题记录等过程都依赖规范完整的需求文档,除功能内容全面外,整洁.易读也是需求文档的重 ...
【产品经理必备文档】述职报告/年终总结汇报ppt模板
今天和大家免费分享产品必备文档模板--产品经理述职文档(年终总结汇报)的ppt模板~~~ [文档下载] 这个ppt模板可以在下方小程序里免费下载哦 [编写教程] 个人工作年终总结一般分成4部门:个人岗 ...
Eolink征文活动---Eolink API文档服务的天才产品
实际上我并不是因为这次活动才知道Eolink,早在几年前,我就成为了Eolink的使用者,所以,这次征文活动我势在必行!本篇文章将会围绕我如何利用Eolink去解决项目问题进行展开讨论,大致分为以下内 ...
一份很不错的敏捷产品接口文档模板
在采用敏捷研发的过程中,前后端开发人员如何来描述与记录接口信息?如何精简的描述接口的用处?接口的请求方式?接口的入参是什么?返回模型是什么等等. 结合我们项目团队多年的实际情况以及授课老师的推荐,我觉 ...
通用产品需求文档模板
很多朋友说,产品需求文档怎么写?很多公司的产品需求文档要求各不相同,但也是大同小异,其实就是说清楚: 基于什么样的背景,我们要做什么事情, 满足什么用户哪一个需求? 需求分解出来,产品的逻辑如何? 交 ...

产品手册API文档模板

文章目录

1 前置信息

2 具体模板

产品手册API文档模板相关推荐

最新文章

热门文章