Hi, After debugging some source codes of Prometheus and Grafana, I define some RestFul API using OpenAPI format,
The best thing of using OpenAPI is, we do not need to write to much code because Swagger or OpenAPI generator can generate the framework. (Go, Python, Java etc.. Sadly, no native Netty Java codes) You can get it here [1] or [2]. Thank Yanhong Wang and Tianci Zhu giving the first version of API and Julian tell me an amazing tool [3] for writing OpenAPI. [1] https://app.swaggerhub.com/apis/jixuan1989/iotdb/1.0.0 [2] https://issues.apache.org/jira/browse/IOTDB-400 [3] stoplight.io Best, ----------------------------------- Xiangdong Huang School of Software, Tsinghua University 黄向东 清华大学 软件学院 Xiangdong Huang <[email protected]> 于2021年1月2日周六 下午2:19写道： > Hi, > > we'd like to develop some restful APIs for: > > 1. native Grafana plugin (Grafana uses typescript language, so using > restful API is a solution) > > 2. other cross-language applications. > > According to previous discussions (several months ago on the mailing > list), we will use Netty to implement the REST. > > Now, I'd like to raise up a discussion about how to define the API, > especially for authentication. Is someone familiar with it? (Tianci had a > prototype and published it on postman [1]. But I think we still need to do > a lot, e.g., authentication.) > > Some interfaces that will be included: > - authentication > - simple write data (write a record, with a device, a timestamp, a > number of measurements) > - simple data query (a number of Paths, raw data query or aggregation > query, time limit, size limit) > - down-sampling query, (a number of Paths, aggregation function, > downsampling time interval, fill function, time limit, size limit) > - any IoTDB SQL. > > [1] https://documenter.getpostman.com/view/12320024/T1LLDnuj > > Best, > ----------------------------------- > Xiangdong Huang > School of Software, Tsinghua University > > 黄向东 > 清华大学 软件学院 >
