我有一个Web服务器,它向外部应用程序公开一个接口。
所有方法均作为POST请求发送(读取以及写入/更新)。
只有一个端点URL可以访问所有 方法(“ /服务”)。 POST正文中有一个名为 定义要调用的方法名称的“函数”。
我该如何迅速地记录此服务器的API。一个例子做类似的东西将不胜感激。
例如:这是POST请求的示例正文:
端点网址: https://test-web-service.example.com/serve
类型: POST
身体:
getCustomerById
{
"function": "getCustomerById",
"args":
["CUST00001"]
}
getAllCustomers
{
"function": "getAllCustomers",
"args":
[]
}
createCustomer
{
"function": "createCustomer",
"args":
["CUST001","MAC","mailto:mac@example.com","PO Box 39100, Howick"]
}
updateCustomer
{
"function": "updateCustomer",
"args":
["CUST001","MAC OWENS","mailto:mac@example.com","PO Box 39100, Howick"]
}
谢谢!