在我的职业生涯中,我使用了数百个 REST API 并制作了数十个。由于我经常在 API 设计中看到相同的错误,因此我认为写下一组最佳实践可能会更好。 [规则#1:集合时一定要使用复数名词](github.com/stickfigure/rule-1-do-use-plural-nouns-for-collections) 这是一个任意的约定,但它是公认的,而且我发现违规往往...
https://api.example.com/animal_types https://api.example.com/employees 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 5、method,对资源的具体操作类型,常用的有5个。 常用的5个HTTP动词: GET(SELECT):从服务器取出资源(一项或多项)。 POST(CREATE):在服务器新建一个资源。 PUT(UP...
因为Controller的路由地址已经包含了countryId参数,UrlHelper会自动处理这个问题的;而rel的值可以自行填写,这里我用self来表示本身,API消费者需要知道这部分,通过rel的值,API消费者就会知道API提供了哪些功能;最后method的值是GET。 其它几个链接也是类似的。根据需要你可以添加额外的链接,但是针对本文这个简单的例子,这些...
"proc_name": "sp_Test1", //存储过程名称 "method": "open_proc", //open_proc、exec_proc、exec_func "params": [{ //输入参数,输出参数不用填 "name": "@p1", "value": 10 }, { "name": "@p2", "value": "abcdefg" }] } ② 签名算法 http://open.taobao.com/doc2/detail.htm?ar...
405 Method Not Allowed 请求方法不能被用于请求相应的资源,如使用PUT方法访问只接受POST方法的API 500 Internal Server Error 服务端内部错误 502 Bad Gateway 网关错误 504 Gateway Timeout 网关超时 3.1 成功类 对于成功类,除了GET请求需要返回响应体(数据)之外,其他请求均可不返回响应体。
Method: HEAD Request URI:http://jsonplaceholder.typicode.com/posts #3) POST #4) PUT #5) OPTIONS Request Parameters: Method: OPTIONS Request URI:http://jsonplaceholder.typicode.com/ Headers: Content-type = Application/JSON #6) PATCH Best Practices While Validating A REST API ...
https://api.contoso.com/v1.0/people/jdoe@contoso.com/inbox PS:通过以上URL我们可以获知API的版本、people资源、用户标识(邮箱)、收件箱,而且很容易获知——这是jdoe的收件箱的API。 An example URL that is not friendly is: 格式不友好的 URL Demo: ...
There are several types of parameters found in REST APIs. While building a REST API, you need to decide which parameter suits the endpoint.
method 要调用的 Telegram 机器人 API 方法。 parameters 已指定的方法的参数。 支持以下 Telegram 方法: answerInlineQuery editMessageCaption editMessageReplyMarkup editMessageText forwardMessage banChatMember sendAudio sendChatAction sendContact sendDocument sendLocation sendMessage sendPhoto sendSticker send...
POST: This method permits the server to create a new entry in the database. DELETE: This method allows the server to delete an entry in the database.REST vs. SOAP APIsRelated: What is a SOAP API?There has always been a debate in the application programming interface (API) industry about...