api接口文档

最新推荐文章于 2024-08-01 08:17:37 发布
最新推荐文章于 2024-08-01 08:17:37 发布
阅读量1k 收藏 21
点赞数 15
文章标签： 人工智能
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_41165446/article/details/139120705
版权

技能执行API

查看api 接口

在这里插入图片描述
在这里插入图片描述

  • cURL： bash环境下快速测试api功能
  • **Python API：**通过Python调用RestFul API接口，本质和 cURL是一样的
  • Python Code: 将bisheng作为Python 依赖，通过本地实例化技能，本地执行
  • **Tweak：**配置每个组件的变量表，可选，不传就会用技能中默认配置的，如果传可以覆盖技能中配置的参数

使用说明

接口协议

  1. API 服务地址是 http://IP:Port/api/v1/process/{flow_id} IP 和Port 是服务部署的地址

  2. 参数说明

    1. 是否必填value类型说明示例备注
      flow_id是UUID技能IDURL传参
      inputs是Json对整个技能的问题输入 json里的具体key和技能本身相关，不一定都是query{“query”:“什么是金融”}当输入节点只有一个时，id可不传
      history_count否int对于技能里支持Memery，选取几条历史消息进行多轮问答，默认值10
      session_id否str用于session查找，当我们进行多轮时，此参数必填，且建议采用后端生成的key每次调用，当session_id 传入时，返回传入sessionid，当session_id不传时，自动生成id
      tweaks否Json对每个组件的控制，可以替换组件输入参数的值当没有指定组件传参的时候，可以不传
      ChatOpenAI-MzIaCJson示例，技能中OpenAI大模型组件的配置信息，key为组件名，命名为{组件}-{id}{“openai_api_key”: “sk-xxx”}或者 {}当{}为空，表示保持默认值
      …每个技能中各个组件的参数均可以在调用接口时传进去，如果不传则用技能的默认配置

  3. 返回参数

返回格式采用统一格式：{“status_code”:200,“status_message”:“SUCCESS”,“data”:{}}}

key类型含义
dataobject返回内容
data.session_idstring会话id，用来和入参对应
data.resultobject技能返回的结果
data.result.answerstr技能统一key返回的LLM 内容
data.result.message_idint技能历史消息存储id
data.result.sourceint是否溯源： 0 不可溯源， 1 普通溯源， 2有访问权限，3/4 特殊情况下的溯源
data.result.{key}stringkey是技能里组件定义的输出key， 输出的内容和answer一致，唯一的区别是key不固定

Curl 示例

# cURL示例
# 从技能编辑页面获取到技能接口及参数，以下为示例，不代表和实际的一致
url="http://IP:3001/api/v1/process/"
flow_id="3d01af25-4aea-4193-ad14-a509ae8cacfc"
curl -X POST ${url}${flow_id} \
 -H 'Content-Type: application/json' \
 -d '{"inputs": {"query":"什么是金融","id":"纽约时报"}, 
      "tweaks": {
          "ChatOpenAI-MzIaC": {},
          "BingSearchRun-MzDJj": {},
          "BingSearchAPIWrapper-UhpQW": {},
          "ZeroShotAgent-dWiEk": {}
          }}'

Python示例

import requests
from typing import Optional
BASE_API_URL = "http://{IP}:{port}/api/v1/process"
FLOW_ID = "f558ee24-55c5-4c0d-967f-0beb27b660d0"
# You can tweak the flow by adding a tweaks dictionary
# e.g {"OpenAI-XXXXX": {"model_name": "gpt-4"}}
TWEAKS = {
  "ConversationChain-A1J5d": {},
  "ProxyChatLLM-NloT5": {}
}
def run_flow(inputs: dict, flow_id: str, tweaks: Optional[dict] = None) -> dict:
    """
    Run a flow with a given message and optional tweaks.

    :param message: The message to send to the flow
    :param flow_id: The ID of the flow to run
    :param tweaks: Optional tweaks to customize the flow
    :return: The JSON response from the flow
    """
    api_url = f"{BASE_API_URL}/{flow_id}"
    payload = {"inputs": inputs}
    if tweaks:
        payload["tweaks"] = tweaks
    response = requests.post(api_url, json=payload)
    return response.json()
# Setup any tweaks you want to apply to the flow
inputs = {"input":"什么是金融"}
print(run_flow(inputs, flow_id=FLOW_ID, tweaks=TWEAKS))

实战Demo

报告生成

报告生成的技能demo

在这里插入图片描述

Step 1 查看api接口

在这里插入图片描述

Step 2 查找需要通过接口上传的Node

一般有 inputFileNode/ variableNode

通过应用会话可以看到上传参数的界面，本例子只有两个文件对应api接口里tweak的：InputFileNode-16u46/ InputFileNode-0zsI2

在这里插入图片描述

step3, 准备入参，本列子是两个文件

import requests
def upload_file(local_path: str):
    server = "http://ip:port"
    url = server + '/api/v1/knowledge/upload'
    headers = {}
    files = {'file': open(local_path, 'rb')}
    res = requests.post(url, headers=headers, files=files)
    file_path = res.json()['data'].get('file_path', '')
    return file_path
    
 financeA = upload_file("caibao.pdf")
 financeB = upload_file("caibao2.pdf")

Step 4, 组装tweaks

# 所有apidemo里没有更新的都可以删除，保持代码清晰
tweaks = {
  "InputFileNode-ozsI2": {"file_path": financeA},
  "InputFileNode-16U46": {"file_path": financeB},
  "Milvus-6HDPE": {"collection_name": "tmp", "drop_old": True} # 临时知识库，目前需要手动指定collection
}

Step 5，执行

response = requests.post(url="http://192.168.106.120:3002/api/v1/process/940a528f-eccc-4d43-aa19-55c4725645cf",
    json={"inputs": {"report_name":"","id":"Report-tuc6Q"}, "tweaks": tweaks})


print(response.text)
Preset Question预置问题

之前接口不支持Preset Question——即使技能中配置了Preset Question，通过接口也无法触发。

升级后，调接口时只需传文件链接参数便可以触发对该文件的Preset Question问答。

Python Code

Python Code 方式不依赖服务端，不依赖数据库，通过本地json文件方式，直接将技能load进程序，然后利用Bisheng 依赖实现技能的实例化。

  • 由于官方没有发布bisheng的package包，因此无法通过pip 直接安装
  • 因此在本地测试时，需要考虑测试文件和Bisheng 程序目录之间的关系
from bisheng import load_flow_from_json

def _test_python_code():
    TWEAKS = {
        'PyPDFLoader-RJlDA': {},
        'InputFileNode-hikjJ': {
            'file_path':
                'oss 文件地址'  # noqa
        },
        'InputNode-keWk3': {},
        'Milvus-VzZtx': {},
        'RetrievalQA-Y4e1R': {},
        'CombineDocsChain-qrRE4': {},
        'RecursiveCharacterTextSplitter-C6YSc': {},
        'ProxyChatLLM-oWqpn': {
            'elemai_api_key':
                'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJiaXNoZW5nX29wZW42IiwiZXhwIjoxNzEzNzU0MjUyfQ.ww1l-GTBYJiHV3-U1JcacvWOqYPd-QMpuJIeuO9_OM8'  # noqa
        },
        'HostEmbeddings-EJq6w': {}
    }
    flow = load_flow_from_json('/Users/Downloads/⭐️ PDF文档摘要-zxf.json', tweaks=TWEAKS)
    # Now you can use it like any chain 
    inputs = {'query': '合同甲方是谁'}
    print(flow(inputs))

_test_python_code()

示例中，

  1. 我们将 OSS 文件地址通过tweak 对象传入InputFileNode这个组件。
  2. 通过load_flow_from_json 获得可执行对象flow
  3. Inputs 是技能输入，可以通过 flow(inputs) 直接执行

通过api和python code 都是使用flow的同步请求，因此不支持stream等用法。

QA

  1. 怎么上传文件
    1. 当前的上传，是通过接口上传到bisheng临时目录，获得临时目录地址
      1. 接口api： /knowledge/upload
      2. 将接口返回的地址（或者直接oss地址）直接通过tweak 参数传入，以下提供一个示例
import requests
from typing import Optional

BASE_API_URL = "http://ip:port/api/v1/process"
FLOW_ID = "e4917a84-fad7-4d5d-85fd-bf2ec3c42c26"
TWEAKS = {
    "CombineDocsChain-Pud2p": {},
    "RetrievalQA-qH6Mk": {},
    "OpenAIProxyEmbedding-yvld7": {},
    "PyPDFLoader-SIeEa": {},
    "InputFileNode-jdLkB": {},
    "Milvus-T3kRH": {"collection_name": "col_333"},
    "ChatOpenAI-qVQL6": {}
}


def upload_file():
    server = "http://ip:port"
    url = server + '/api/v1/knowledge/upload'
    headers = {}
    files = {'file': open('/Users/sara/Desktop/20231201-223053.jpeg', 'rb')}
    res = requests.post(url, headers=headers, files=files)
    file_path = res.json()['data'].get('file_path', '')
    return file_path


def run_flow(inputs: dict, flow_id: str, file_path: str, tweaks: Optional[dict] = None) -> dict:
    api_url = f"{BASE_API_URL}/{flow_id}"
    payload = {"inputs": inputs}

    if tweaks:
        payload["tweaks"] = tweaks

    payload["inputs"]["file_path"] = file_path  # Add the file_path to the inputs
    
    if "InputFileNode-jdLkB" in tweaks:
        tweaks["InputFileNode-jdLkB"]["file_path"] = file_path
    response = requests.post(api_url, json=payload)
    return response.json()


# Get the file path from api_call
file_path = upload_file()

# Setup any tweaks you want to apply to the flow
inputs = {"query": "总结下文档内容", "id": "RetrievalQA-qH6Mk"}
print(run_flow(inputs, flow_id=FLOW_ID, file_path=file_path, tweaks=TWEAKS))

代码执行效果

在这里插入图片描述

  1. Python Code 支持报告内置问题吗？
    1. 不支持，需要手动通过input 将预置问题挨个请求

知识库

文件上传

接口地址：http://ip:port/api/v1/knowledge/upload

请求方式：POST

**返回格式：**JSON

**返回内容：**file_url

参数必选类型及范围说明
filetrueForm-data需要通过form传参

知识库创建

接口地址：http://ip:port/api/v2/filelib/

请求方式：POST

**返回格式：**JSON

参数必选类型及范围说明
nametruestring知识库名称
modeltruestringembedding模型，跟系统配置有关，请确保embedding 模型在系统配置中正确配置
descriptionfalsestring

知识库修改

接口地址：http://ip:port/api/v2/filelib/

请求方式：PUT

**返回格式：**JSON

参数必选类型及范围说明
nametruestring知识库名称
modeltruestringembedding模型，跟系统配置有关，请确保修改的embedding 模型在系统配置中正确配置
descriptionfalsestring知识库描述

知识库删除

接口地址：http://ip:port/api/v2/filelib/{knowledge_id}

请求方式：DELETE

**返回格式：**JSON

获取知识库列表

接口地址：http://ip:port/api/v2/filelib/

请求方式：GET

**返回格式：**JSON

参数必选类型及范围说明
page_sizetrueint从1 开始
page_numtrueint

针对milvus和es进行临时文件清理

接口地址：http://ip:port/api/v2/filelib/chunk_clear

请求方式：POST

**返回格式：**JSON

参数必选类型及范围说明
collection_namefalsestr明确知道需要清理milvus到哪个collection，对于非tmp开始的collection_name 慎用
index_namefalsestr明确知道需要清理es的哪个index，对于非tmp开始的index_name 慎用
flow_idfalsestr当前技能下没有进入回话列表的临时库，在技能编排测试的时候会生成
chat_idfalsestr通过应用界面使用，产生的临时表，api 调用产生的则传入对应sessionId 值。

知识库文件

文件导入

接口地址：http://ip:port/api/v2/filelib/file/{knowledge_id}

请求方式：POST

**返回格式：**JSON

参数必选类型及范围说明
filetruefile文件
knowledge_idtrueintURL 传入
callback_urlfalsestringbody 传入， 异步回调参数：json={ "file_name": "demo.txt", "file_status": 1, #1=解析中， 2=解析成功，3=解析失败 "file_id": 1, "error_msg": "Exception:" }

文件列表

接口地址：http://ip:port/api/v2/filelib/file/{knowledge_id}

请求方式：GET

**返回格式：**JSON

参数必选类型及范围说明
page_sizetrueint从1 开始
page_numtrueint
knowledge_idtrueint对应知识库id

文件删除

接口地址：http://ip:port/api/v2/filelib/file/{file_id}

请求方式：DELETE

**返回格式：**JSON

文件批量删除

接口地址：http://ip:port/api/v2/filelib/delete_file

请求方式：POST

请求参数：list直接传

参数类型传参方式含义demo
file_idlistpost文件id列表requsts.post(url, json=[1,2,3])

**返回格式：**JSON

聊天Chat

免密websocket接口

现有接口是websoket方式

ws://ip:port/api/v2/chat/ws/{flow_id}

参数类型传参方法参数含义注意
chat_idstringget前端随机id用来表示一个会话窗口
flow_idstringUrl 传参技能id，对应已经上线了的技能
knowledge_idint知识库id知识库id
tweakjsonApi 组件传参针对特定组件进行参数设置 0.2.2.3 版本支持需要urlencode Json对象

使用websocket 返回客户端消息

返回参数key类型含义
is_botbool必要，true消息在左边，false 消息在右边
messagestr/ json返回的消息最终结果
typestrbegin/close 表示整轮会话的开始和结束，start/stream/end 表示stream的开始和结束
categorystrprocessing: 暂无特别实用 question/answer/report/system: 对应前端不同的展示样式
user_idint当前用户id
message_idint消息id
sourcebool是否支持溯源， 0 不支持， 1 支持， 2有权限限制，3 问答库， 4 QA库
flow_idstr（必传）当前聊天的技能id
chat_idstr（必传）当前会话id

当我们完整构建一条消息，需要后端给前端发送4条消息： type=begin, category=system

type=start, category=system

type=end, message=“”

type=close, category=system

点赞

接口地址： http://ip:port/api/v2/chat/liked

接口请求方式： POST

返回格式： json

参数参数含义注意
message_id
liked0 初始值， 1 赞，2 踩

获取点赞数

接口地址：http://ip:port/api/v2/data/msg_like

接口请求方式： GET

返回格式： json

参数含义是否必填
liked用户是否喜欢 0未评价/1 喜欢/2 不喜欢是
flow_id技能id是
create_time开始时间 ‘%Y-%m-%d %H:%M:%S’否
create_time_end结束时间 ‘%Y-%m-%d %H:%M:%S’否

点踩后反馈建议

接口地址：http://ip:port/api/v2/chat/comment

接口请求方式： POST

返回格式： json

参数参数含义注意
message_id
comment评论的内容不超过4096 大小

已解决/未解决

接口地址： http://ip:port/api/v2/chat/solved

接口请求方式： POST

返回格式： json

参数参数含义注意
chat_id
solved0 初始值， 1 解决, 2 未解决

API 溯源接口

# 第一步执行api访问
def _test_python_api():
    url = "http://127.0.0.1:3001/api/v1/process/c33c50dd-30ac-4e9b-a2c0-fd13c4bce245"
    body_json = {
        "inputs": {
            "question": "SQLAgent 是什么",
            "id": "ConversationalRetrievalChain-bZmFo"
        },
        "tweaks": {
            "ConversationalRetrievalChain-bZmFo": {},
            "ChatOpenAI-Y0pJc": {},
            "ConversationBufferMemory-VTj8f": {},
            "Milvus-NhYXG": {}
        }
    }
    resp = requests.post(url, json=body_json)
    # 返回实例
    # result 对象中，source != 0 表示可以溯源
    # 通过 message_id查询溯源的数据
    # {
    #     "result": {
    #         "answer":
    #         "SQLAgent 是 Microsoft SQL Server 中的一个组件，它是一个作业调度程序，用于自动执行和管理 SQL Server 数据库中的作业和任务。SQLAgent 可以通过计划和配置来执行诸如备份、恢复、数据清理和索引重建等操作。它还可以设置警报和通知，以便管理员能够及时了解数据库中的问题和事件。",
    #         "source": 1,
    #         "message_id": 30522
    #     },
    #     "session_id": "A61GFF:538546578b93520116fe329d8df03e9805354919b50c8a946a0b47fa565ee350",
    #     "backend": "anyio"
    # }
    # 0: 不溯源
    # 1: 普通溯源
    # 2: 有访问权限限制溯源
    # 3: 知识库外部链接溯源
    # 4: QA溯源

# 第二步，获取溯源内容
def get_source(message_id):
    # keywords  是表示当前答案，有哪些关键字, 非必要
    keywords_url = f"http://127.0.0.1:3001/api/v1/qa/keyword?message_id={message_id}"
    keyword_resp = requests.get(keywords_url)

    # chunk 获取接口，当我们需要根据关键字进行排序，需要将上一个关键字的结果，拼接到keys 参数下。 ";" 分割
    chunk_url = f"http://127.0.0.1:3001/api/v1/qa/chunk?message_id={message_id}&keys="
    chunks = requests.get(chunk_url)
    print(chunks)
    #
    # {
#     "data": [{
#         "chunk_bboxes": [{
#             "page": 1,
#             "bbox": [90, 74, 226, 85]
#         }],  # 用来定位文本位置
#         "right": true,
#         # 双层pdf 路径
#         "source_url":
#         "http://110.16.193.170:50061/bisheng/10832?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20231228%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20231228T060923Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=053b4f399bbf3bdf3f4c86f750419bfde3739b4a2eee3e5490c4b63030ce66e5",
#         # 原始文件路径
#         "original_url":
#         "http://110.16.193.170:50061/bisheng/original/10832?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20231228%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20231228T060923Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5ad4e49c5ff47aff425f472dbe21b11ce6d3ab65964292f61d1412a0ec07a3a6",
#         "score": 0,
#         "file_id": 10832,
#         "source": "多少专利和知识产权.pdf"
#     }],
#     "msg":
#     "success"
# }

特殊文档上传（同步方法）

使用场景见RetrievalChain

QA库内容上传 - 文件方式导入

内容说明
文件文件内容就是 问题文本
文件名问题文本
Answer答案文本
URL锚点URL，知识库文章链接拼上这个QA的id

接口地址： http://ip:port/api/v2/filelib/chunks

接口请求方式： POST

返回格式： json

参数：

参数是否必传参数含义注意
knowledge_id是Int 值传入知识库ID349 测试传参
file是formData 传入文件
metadata是对文件进行补充的metadata 采用string传入json类型
metadata.answer否QA 场景的答案， QA场景必填
metadata.url否锚点URL，知识库文章链接拼上这个QA的id

返回参数

参数是否必传参数含义注意
status_code是200非200 为异常
status_message是success
dataJson
idintfile_id, 用来标识系统文件唯一id
statusint上传状态
remarkstr错误原因

Postman 示例：

在这里插入图片描述

代码示例：

def test_file():
    url = 'http://192.168.106.116:7860/api/v2/filelib/chunks'
    data = {'knowledge_id': 349, 'metadata': "{\"url\":\"http://baidu.com\"}"}
    file = {'file': open('/Users/huangly/Downloads/co2.pdf', 'rb')}

    resp = requests.post(url=url, data=data, files=file)
    return resp

QA库内容上传-string 导入

接口地址： http://ip:port/api/v2/filelib/chunks_string

接口请求方式： POST

返回格式： json

参数：

参数是否必传参数含义注意
knowledge_id是POST body349 测试传参
documents是文件List
page_content是文件内容
metadata是补充信息
– metadata.answer否QA 场景的答案，QA场景必填
– metadata.url否锚点URL，知识库文章链接拼上这个QA的id
– source是文件名

返回参数：

参数是否必传参数含义注意
status_code是200非200 为异常
status_message是success
dataJson
idintfile_id, 用来标识系统文件唯一id
statusint上传状态
remarkstr错误原因

代码示例：

#demo
json_data = {
    "knowledge_id": 371,
    "documents": [
        {
            "page_content": "达梦有多少专利和知识产权？",
            "metadata": {
                "source": "达梦有多少专利和知识产权？.txt",
                "url": "",
                "answer": "达梦共有177个已获授权专利情况，293个软件著作权情况",
                "page":1
            }
        }
    ]
}

url= 'http://192.168.106.116:7860/api/v2/filelib/chunks_string'
resp = requests.post(url=url, json=json_data)
resp

QA 溯源信息接口

接口地址： http://ip:port/api/v2/chat/source

接口请求方式： GET

返回格式： json

参数

参数参数含义注意
message_id每条消息都会返回messageId

返回参数

参数参数含义注意
id溯源id
chunk文本块(QA 对应问题)
meta_datadict， 对应文本愿信息
metadata.url溯源信息
metadata.answer
metadata.title对应文title
是伟嘉
关注
  • 15
    点赞
  • 踩
  • 21
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
一份完整的接口文档
weixin_42575367的博客
11-22 9380
https://www.jianshu.com/p/c5b1828d0dc6
产品经理必须懂的api接口文档编写规范，api接口文档入门
tbprice的博客
07-05 2558
更为常见的是，API接口很可能是远程的服务端API，其背后采用Java、PHP、C#、Pyhon、C/C++、Ruby、Scala等一种或多种后端语言开发搭建，提供了数据存储、通讯、各类服务等功能。应用程序的开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。除此之外，从专业角度来说，API不仅代表着接口本身，还蕴含了服务端的整体系统架构、数据存储、服务端管理、第三方系统的整合等，只是对外看来，表现出来的是API接口。增删改本质都是写的动作。
api接口文档模板
03-06
api接口文档模板
产品经理必会的10种数据分析方法
weixin_34061482的博客
08-01 879
随着人口和流量红利的下降，互联网行业必然会朝着精益化运营的方向发展。数据分析在很多互联网人的工作中越发显得重要，而对于产品经理来说，更是如此。本文将为产品经理介绍数据分析的基本思路，并基于此，衍生出 2 个常见方法和 7 个应用手段，希望在数据分析的实际应用中能给大家带来帮助。 一、数据分析的基本思路 数据分析应该以业务场景为起始思考点，以业务决策作为终...
Java——API文档使用
yang_54120的博客
03-30 1355
Java的API主要分为以下几个大类：1. Java SE（Standard Edition）API：这是Java的标准版API，提供了基础的类和接口，用于开发普通的桌面应用程序和命令行工具。2. Java EE（Enterprise Edition）API：这是Java的企业版API，提供了更多面向企业级开发的类和接口，包括Web应用程序开发、分布式系统开发、消息传递等。
android api接口文档,API 接口文档
weixin_33435461的博客
05-28 1464
API 接口文档接口类说明本文档所有接口所涉及的相关类及说明如下：接口说明GsManagerSDK 功能接口类，用于调用个数相关功能GsConfigSDK 配置接口类，用于设置个数相关参数(注意：GsConfig 配置类需要在 SDK 初始化之前配置。)获取 GsManager类名com.getui.gs.sdk.GsManager接口public static GsManager getInst...
Api接口文档
wtyzky的博客
11-05 4073
Api接口文档 1.1接口文档说明 接口基准地址： http://teaapi.wtycms.cn/ 服务端已开启 CORS 跨域支持 API 认证统一使用 Token 认证 需要授权的 API ，必须在请求头中传递token字段提供 token 令牌 1.2登录验证接口 请求路径：login 请求参数 参数名 参数说明 name 用户名（测试账号：hnkj 密码123456） password 密码 1.3注册接口 请求路径：Regist
API接口文档范文-API接口文档示例
backKeith的博客
02-22 8395
本文主要是提供了一个接口文档的范文，内容修订历史、目录、时序图、接口要素描述、接口说明、使用示例、字典、FAQ。
comfyui api接口文档
向来缘浅，奈何情深
11-13 6002
comfyui api接口文档
Awvs API接口文档
11-20
整理网络资源，根据网络上的相关文档结合自己的实际操作整理的AWVS11的API接口文档，官方的API接口文档是商务付费的，所以只能自己整理。我所使用的接口测试工具为curl，curl的具体安装和相关参数请度娘。核心参考...
API接口文档模版.zip
07-23
API接口文档是软件开发中必不可少的一部分，它定义了服务提供者和消费者之间的交互方式，确保双方能够顺畅地进行数据交换。这份"API接口文档模版.zip"包含了两种格式的文档：一个Markdown（.md）文件和一个PDF文件，...
最新追书神器API接口文档
05-02
《最新追书神器API接口文档》是一份专为阅读类应用开发者提供的技术指南，它包含了构建小说阅读平台所需的各种功能接口。以下是对这些接口的详细解释： 1. **获取所有分类类型值接口**：通过/cats/lv2/statistics...
黑马头条前台API 接口文档
10-30
黑马头条前台-API 接口文档：用户登录，注册，编辑关注取消，评论；新闻文章：搜索，推荐，详情，列表获取，发布，收藏，点赞，编辑，文件上传；首页栏目获取和添加
java的API接口文档模板
01-12
Java API接口文档模板详解 Java API接口文档模板是Java初学者必须掌握的重要知识点之一。该文档模板提供了详细的接口输入输出定义，旨在帮助前后端开发人员快速了解和使用接口。下面我们将对该文档模板进行详细解释...
新版API接口文档
前端小牛__栗鼠
08-26 1866
内部新版API接口文档 一、API接口请求规范 接口域名: https://api.jushuitan.com/ 线上环境必须是https协议，苹果已声明必须使用https request、reponse的数据包： 使用json格式，字符集必须为utf-8 使用gzip方式请求，以便提高接口的传输效率 出入参数以驼峰规则，类似userName 入参协议示例： { "name":"名字 [require | string | min:2 | max:8]", "age"
常见的文心一言的指令
知码客
07-25 2139
文心一言，作为百度研发的预训练语言模型“ERNIE 3.0”的一项功能，能够与人对话互动，回答问题，协助创作，高效便捷地帮助人们获取信息、知识和灵感。
和数集团十周年庆典：新起点、新目标、新征程
最新发布
Likelib的博客
08-01 945
在十周年庆典这个特殊的日子，和数集团对在市场开拓、客户服务等方面具有突出表现的个人进行了表彰。
嵌入式 api接口文档
05-30
嵌入式系统的 API 接口文档通常包括以下内容： 1. 功能说明：简要介绍 API 接口的功能和作用。 2. 参数说明：列出 API 接口需要传入的参数及其含义、数据类型、范围等信息。 3. 返回值说明：列出 API 接口的返回值及其含义、数据类型、范围等信息。 4. 使用示例：提供一个或多个使用 API 接口的示例代码，方便开发人员理解和使用。 5. 错误码说明：列出 API 接口可能返回的错误码及其含义、原因等信息。 6. 接口版本和更新记录：记录 API 接口的版本号和更新历史，方便开发人员查看接口的变化和升级。 7. 其他注意事项：列出 API 接口使用过程中需要注意的事项，如线程安全性、资源占用等。 需要注意的是，嵌入式系统的 API 接口文档通常会更加精简和简洁，因为嵌入式系统的资源和存储空间比较有限。同时，由于嵌入式系统的环境相对封闭和固定，API 接口也比较稳定和不易变化。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值