Question

对于我的第一个API文档（非常简单的API，只有一个方法），我或多或少都有这种结构：

                           API documentation

1.Disclaimer
2. Using the API
2.1 Input data -> Here I explain how should be the input data, JSON
2.2 Output data > Here I explain which data should be obtained and in JSON
2.3 Example -> I am giving an example of my input and output

在2.3中我解释了输出（我的文档中的实例，我在这里只发布了它的外观结构）应该如下所示：

{"message":"Succesful ","data":{"batt1":{"value1":977.48279000017,"value2":977.4208279000022,"value3":1034.9372639500002,"value4":2534.854048049996,"value5":2465.145176450681,"value6":2465.1451764508347},"batt2":{}...}

但它错过了我如何在这个例子中提出请求。到目前为止，我一直使用此命令来使用/测试我的API：curl -i -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '@alldata.json' http://localhost:3000/api/v1/namecontroller

我应该在2.3中加入我的文档：

在此示例中，我使用以下格式的cURL命令：curl -i -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '@alldata.json' http://localhost:3000/api/v1/namecontroller

对不起，我对这一切都很陌生，RoR，API等...

你有什么想法吗？

Answer 1

我认为您可以用以下格式显示它，以便易于理解

url: http://localhost:3000/api/v1/namecontroller
method: POST
Body : @alldata.json

API文档RAILS

1 个答案: